Update a data model from a JSON representation (Beta)

This endpoint replaces the data model with a data model from a JSON representation. You can programmatically update the data model's structure, metadata, and contents. This creates a new version of the data model, which is accessible from the Sigma UI.

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

For more information on managing data models via the Sigma API, see Create and manage data models from code. For more information on using this endpoint, including an end-to-end example, see Update a data model from a JSON representation.

Usage notes

• To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
• Retrieve a representation of an existing data model by calling the /v2/dataModels/{dataModelId}/spec endpoint.
• To create a new data model from code, use the /v2/dataModels/spec endpoint instead.
• The endpoint only supports updates to the pages array and its contents. Additional fields are not required and are ignored in the request body.
• Partial updates are not supported. You must provide the entire representation of the data model in the request body.

Usage scenarios

• Automation: If you want to update several data models across one or more organizations, or in response to external events, you can use this endpoint to programmatically update the data models.
• Integration: Using this endpoint, you can update data models based on external data sources or integrate Sigma with other tools and platforms.
• Version control: Developers can use this endpoint to programmatically manage, update, and version control data models between several organizations or tenants.