SIsigmacomputing
Data models

Create a materialization schedule for a data model element (Beta)

This endpoint creates a materialization schedule for an element in a data model. The scheduled run materializes the element's data on the given cadence, allowing the data to be stored or cached for optimized access and performance.

For more details on materialization, see Materialization.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

  • Retrieve the dataModelId by calling the /v2/dataModels endpoint.
  • Retrieve the elementId by calling the /v2/dataModels/{dataModelId}/elements endpoint.
  • Write access must be enabled on your connection.
  • To perform this operation, you must use API credentials owned by a user assigned to an account type with the Schedule materializations permission.
  • An element can have at most one materialization schedule.
post/v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

dataModelIdstring required

Unique identifier of the data model.

elementIdstring required

Identifier of the data model element to materialize on a schedule. Must be an element, such as a table, that can be materialized.

Request body

Response

The newly created materialization schedule.

sheetIdstring required

Identifier of the materialization schedule for the element

elementIdstring required

Identifier of the element being materialized

elementNamestring required
configuredAtstring date-time required
pausedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.