Need help? Get answers from the docs with Omni's in-app AI! Log in to your Omni instance and open the Omni Agent in the sidebar.
Getting started
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"
}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_idquery parameter is required. Thebranch_idis validated against the shared model. - If Branch-based schema refresh isn’t enabled, do not provide the
branch_idparameter. The API will return a400error in this case.
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"
}Documentation Index
Fetch the complete documentation index at: https://docs.omni.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The ID of the model to be refreshed.
Query Parameters
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.
Whether to perform a hard refresh (removes dropped objects) or soft refresh (additive only). Defaults to true (hard refresh).
Comma-separated list of schemas to selectively refresh. Can only be used when hard_refresh=false.
Comma-separated list of tables to selectively refresh. Can only be used when hard_refresh=false.
Was this page helpful?