Get a field definition by ID
https://{kibana_url}
- GET /api/cases/field_definitions/{field_definition_id}
- GET /s/{space_id}/api/cases/field_definitions/{field_definition_id}
Refer to Spaces for more information.
Returns a single field definition by its ID. Requires the Cases feature to be enabled in the space.
Path Parameters
-
field_definition_idstring · max: 36required -
The identifier for the field definition.
Responses
Indicates a successful call. Returns the field definition.
-
definitionstringrequired -
The field definition as a YAML string. New definitions are limited to 30 000 characters, but existing definitions created via internal tooling may be longer.
-
descriptionstring -
Optional human-readable description of the field's purpose.
-
displayOrderinteger · min: 0 -
Position of a global field in the case details view. Assigned by the server and changed via the Field Library reorder controls.
-
fieldDefinitionIdstring · max: 36required -
Unique server-assigned identifier for the field definition (UUID). May be UUIDv4 for definitions created through the public API, or UUIDv5 for definitions created by internal migration processes.
-
isGlobalboolean -
When true, this field is rendered in every case regardless of which template the case uses.
-
namestringrequired -
The field name. Must match the
nameproperty in the YAML definition and is unique per owner (case-insensitive). Immutable after creation. -
ownerstring · max: 50required -
The application that owns this field definition.
Authorization information is missing or invalid.
-
errorstring -
messagestring -
statusCodeinteger
The user does not have permission to read field definitions for the owner.
-
errorstring -
messagestring -
statusCodeinteger
The field definition was not found.
-
errorstring -
messagestring -
statusCodeinteger