v4

OpenAPI 3.1.02026-08-01207318738.7 KB
Models

Update field

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

Path parameters

modelIdstring uuid required

Model UUID

Example:123e4567-e89b-12d3-a456-426614174000

Model UUID

viewNamestring required

View name

Example:orders

View name

fieldNamestring required

Field name

Example:total_amount

Field name

Query parameters

branch_idstring uuid

Branch ID to use for branch-aware operations

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

Branch ID to use for branch-aware operations

Request body

aiContextstring

AI context for the field

allValuesstring[]

Deprecated: use sampleValues instead

binBoundariesnumber[]

Bin boundaries for binned fields

binLabelsstring[]

Labels for bins

descriptionstring

Field description

drillFieldsstring[]

Drill-down fields

elseValuestring

Else value for grouped fields

filtersobject

Filters for the field

formatstring

Field format

groupFiltersobject[]

Group filters

groupLabelstring

Group label

groupNamesstring[]

Group names

hiddenboolean

Whether the field is hidden

ignoredboolean

Whether the field is ignored

isCalcboolean

Whether this is a calculation field

labelstring

Field label

newFieldNamestring

New field name (for rename)

newViewNamestring

New view name (for move)

sampleValuesstring[]

Sample values for the field

sqlstring

SQL expression for the field

synonymsstring[]

Synonyms for the field

tagsstring[]

Tags for the field

topicContextstring

Topic context for the field

Response

Field updated successfully

successboolean required

Whether the operation was successful

Example response

{
  "success": true
}