Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Models

Create model

Create a new model. The typical workflow for using this endpoint is:

  1. Create a schema model using this endpoint
  2. Use the Refresh schema endpoint to load the schema for the created model
  3. Create shared models based on the schema model
post/v1/models

Request body

connectionIdstring uuid required

ID of the connection the model is based on.

modelKind'SCHEMA' | 'SHARED' | 'SHARED_EXTENSION' | 'BRANCH'

Type of model.

  • SCHEMA - Mirrors the database structure
  • SHARED - Represents the universal, governed data model that workbooks are based on
  • SHARED_EXTENSION - Represents an extension to the SHARED model. Can be used to dynamically extend the SHARED model based on user attributes, or as a model that workbooks are based on in a departmental use case.
  • BRANCH - A model layer that is used to develop modifications to the production shared model

For more information, see the Modeling documentation.

modelNamestring

Name of the model.

baseModelIdstring

Applicable to branch and extension models. ID of the base model.

allowAsWorkbookBaseboolean

Only applicable to SHARED_EXTENSION models. If true, allows the model to be selected as a base model when creating workbooks.

useIsolatedBranchesboolean

Only applicable to SHARED_EXTENSION models. If true, branches are shown on the extension model page instead of parent shared model.

Response

Model created successfully

errorstring

Error message if creation failed

messagestring

Additional message

successboolean

Indicates if the operation succeeded