OMomni
Models

Rename model

Changed on
<Note> **Connection Admin** permissions are required to rename a shared model or shared extension model. **Modeler** permissions and higher are required to rename a branch model. </Note> <Warning> Workbook models and query models cannot be renamed via this endpoint. </Warning>

Rename a model. This endpoint allows you to programmatically rename models without using the UI, which is particularly useful for bulk operations on shared extension models created via POST /api/v1/models.

The new name must be unique among active models with the same modelKind and baseModelId.

Branch-specific constraints:

  • Name must match git-compatible regex: [\w\-/]+
  • No git ref path conflicts (e.g., cannot rename to team if team/project exists)
  • Cannot rename branches with an open pull request (when pullRequestUrl is set) — renaming would desync Omni from the git remote
patch/v1/models/{modelId}

Request

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

Path parameters

modelIdstring uuid required

ID of the model to rename.

Request body

namestring required

The new name for the model.

Example request

{
  "name": "customer_metrics_v2"
}

Response

Model renamed successfully

idstring uuid

ID of the model.

baseModelIdstring uuid nullable

ID of the base model, if applicable.

connectionIdstring uuid nullable

ID of the connection the model is based on.

modelKindstring nullable

The type of model.

namestring nullable

The name of the model.

orgBranchIdstring uuid nullable

ID of the branch as a whole, shared by every model layer that is a member of it. Only set when modelKind is BRANCH; null otherwise. Use this ID with the Branches API.

createdAtstring date-time

The time the model was created.

updatedAtstring date-time

The time the model was last updated.

deletedAtstring date-time nullable

The time the model was deleted, if applicable.

Changes