OMomni
Models

Refresh schema

<Note> This endpoint requires either **Connection Admin** or **Modeler** permissions:
  • Modelers can use this endpoint on connections that have exactly one shared model
  • Connection Admins can use this endpoint on any connection they are an admin of, whether the connection has one or multiple models </Note>

Refresh the schema of the specified model. This will cause the model to reflect the latest changes to schemas, views, and fields from the data source. Schema refreshes will remove structures that are no longer present in the source, but not anything created by users.

Depending on whether the Branch-based schema refresh setting is configured:

  • If Branch-based schema refresh is enabled, the branch_id query parameter is required. The branch_id is validated against the shared model.
  • If Branch-based schema refresh isn't enabled, do not provide the branch_id parameter. The API will return a 400 error in this case.
post/v1/models/{modelId}/refresh

Request

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

Path parameters

modelIdstring uuid required

The ID of the model to be refreshed.

Query parameters

branch_idstring uuid

Required if Branch-based schema refresh is enabled. The ID of the branch for models with this setting enabled.

Do not provide this parameter when the setting is not enabled.

hard_refreshboolean

Whether to perform a hard refresh (removes dropped objects) or soft refresh (additive only). Defaults to true (hard refresh).

When combined with schemas or tables, a hard refresh is scoped to the selection: dropped objects are removed only inside the selected schemas or tables, and the rest of the model is left untouched.

schemasstring

Comma-separated list of schemas to selectively refresh. Only the listed schemas are reloaded; the rest of the model is preserved.

Unless hard_refresh=false is also set, objects inside the selected schemas that are no longer present in the data source are removed.

tablesstring

Comma-separated list of tables to selectively refresh. Only the listed tables are reloaded; the rest of the model is preserved.

Unless hard_refresh=false is also set, objects inside the selected tables that are no longer present in the data source are removed.

Response

Model refresh started

jobIdstring uuid

ID of the job.

modelIdstring uuid

ID of the model.

statusstring

Status of the schema refresh. This value will be running to indicate that the refresh has started.

Example response

{
  "status": "running"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.