Skip to navigation
Sigma REST APIData models{dataModelId}

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

View as Markdown

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

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

Request

The request body.
scheduleobjectRequired
When to run the materialization.

Response

The newly created materialization schedule.
sheetIdstring
Identifier of the materialization schedule for the element
elementIdstring
Identifier of the element being materialized
elementNamestring
scheduleobject or null
configuredAtdatetime
pausedboolean