v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB

/api/field

PUT /api/field/{id}

Update Field with ID.

put/api/field/{id}

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

caveatsstring nullable

{"stackTrail":"paths:/api/field/{id}:put:requestBody:content:application/json:schema:properties:coercion_strategy:oneOf","oasType":"schema","type":"unknown","description":"value must be a valid coercion strategy (keyword or string).","nullable":true}

descriptionstring nullable

display_namestring nullable

fk_target_field_idinteger nullable

value must be an integer greater than zero.

has_field_values'auto-list' | 'list' | 'none' | 'search'

json_unfoldingboolean nullable

nfc_pathstring[] nullable

points_of_intereststring nullable

{"stackTrail":"paths:/api/field/{id}:put:requestBody:content:application/json:schema:properties:semantic_type:oneOf","oasType":"schema","type":"unknown","description":"value must be a valid field semantic or relation type (keyword or string).","nullable":true}

settingsobject nullable

Value must be a map.

visibility_type'retired' | 'sensitive' | 'normal' | 'hidden' | 'details-only' nullable

Response

Successful response