Refresh schema

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/refresh \
  --header 'Authorization: Bearer <token>'

{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "running"
}

Models

Refresh schema

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

Refreshes 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

Refresh schema

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/refresh \
  --header 'Authorization: Bearer <token>'

{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "running"
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

modelId

string<uuid>

required

The ID of the model to be refreshed.

Query Parameters

branch_id

string<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_refresh

boolean

default:true

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

schemas

string

Comma-separated list of schemas to selectively refresh. Can only be used when hard_refresh=false.

tables

string

Comma-separated list of tables to selectively refresh. Can only be used when hard_refresh=false.

Response

Model refresh started

jobId

string<uuid>

ID of the job.

modelId

string<uuid>

ID of the model.

status

string

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

Example:

"running"

⌘I