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.

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

  • 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 make updates at fixed times or in response to external events, you can use this endpoint to programmatically update a data model.
  • Integration: Using this endpoint, you can update data models based on external data sources or integrate Sigma with other tools and platforms.
Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!