OMomni
Models

Create model

Changed on

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

You can also use this endpoint to create branches.

post/v1/models

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/models
  • Auth
    HTTP bearer

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. Controls whether users can explore and query the extension model. If true, the model appears in the model selector when creating a new analysis, and users and AI can run queries against it. If false (the default), the extension model is hidden from the model selector and all exploration, query access, and AI chat access are disabled. Set to true for any extension model intended for end-user or AI interaction.

useIsolatedBranchesboolean

Only applicable to SHARED_EXTENSION models. If true, the extension uses the Develop independently branch workflow: its branches hold a layer on the extension itself instead of on the parent shared model.

Response

Model created successfully

errorstring

Error message if creation failed

messagestring

Additional message

successboolean

Indicates if the operation succeeded

Changes