OMomni
Models

Update field metadata

Changed on

Update a field's metadata on a view. Omitted properties keep their current value.

patch/v1/models/{modelId}/view/{viewName}/field/{fieldName}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/models/{modelId}/view/{viewName}/field/{fieldName}
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

modelIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The ID of the model.

viewNamestring required
Example:orders

The name of the view that contains the field. Must not contain whitespace. A trailing .view or .query.view suffix is ignored.

fieldNamestring required
Example:total_amount

The name of the field to update.

Query parameters

branch_idstring uuid
Example:123e4567-e89b-12d3-a456-426614174001

Branch ID to use for branch-aware operations. Accepts either the org-wide branch ID (an orgBranchId, also returned by the Branches API) or the ID of that branch's layer on this specific model.

Request body

aiContextstring

AI context for the field; null or an empty string clears it

descriptionstring

Field description. Pass as null or an empty string to clear.

elseValuestring

Else value for grouped fields

formatstring

Field format. Pass as null or an empty string to clear.

groupLabelstring

Group label. Pass as null or an empty string to clear.

labelstring

Field label. Pass as null or an empty string to clear.

newFieldNamestring

New field name (for rename)

newViewNamestring

New view name (for move)

sqlstring

SQL expression for the field

topicContextstring

Topic context for the field

Example request

{
  "newViewName": "orders"
}

Response

Field updated successfully

successboolean

Example response

{
  "success": true
}

Changes