Get a field definition by ID Technical preview

GET /api/cases/field_definitions/{field_definition_id}
Api key auth Basic auth

Spaces method and path for this operation:

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_id string Required

    The identifier for the field definition.

    Maximum length is 36.

Responses

  • 200 application/json

    Indicates a successful call. Returns the field definition.

    Hide response attributes Show response attributes object
    • definition string Required

      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.

    • description string

      Optional human-readable description of the field's purpose.

    • displayOrder integer

      Position of a global field in the case details view. Assigned by the server and changed via the Field Library reorder controls.

      Minimum value is 0.

    • fieldDefinitionId string Required

      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.

      Maximum length is 36.

    • isGlobal boolean

      When true, this field is rendered in every case regardless of which template the case uses.

    • name string Required

      The field name. Must match the name property in the YAML definition and is unique per owner (case-insensitive). Immutable after creation.

    • owner string Required

      The application that owns this field definition.

      Maximum length is 50.
  • 401 application/json

    Authorization information is missing or invalid.

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode integer
  • 403 application/json

    The user does not have permission to read field definitions for the owner.

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode integer
  • 404 application/json

    The field definition was not found.

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode integer
GET /api/cases/field_definitions/{field_definition_id} 
curl \
 --request GET 'https://localhost:5601/api/cases/field_definitions/{field_definition_id}' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "definition": "name: priority\nlabel: Priority\ntype: keyword\ncontrol: SELECT_BASIC\nmetadata:\n  options: [low, medium, high]\n  default: medium\n",
  "description": "Ticket priority level.",
  "fieldDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isGlobal": false,
  "name": "priority",
  "owner": "cases"
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "Unable to authenticate with the provided credentials.",
  "statusCode": 401
}
Response examples (403) 
{
  "error": "Forbidden",
  "message": "Unauthorized to access cases",
  "statusCode": 403
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Saved object [cases-template/9da1ea2a-09f8-4d0e-bf9d-09bf8c9d0f42] not found",
  "statusCode": 404
}