Get the fields applicable to an existing case

Base URL
https://{kibana_url}
Auth

Returns the fields you can write to the case's extended_fields. The case determines the owner and any applied template. The response includes the owner's global fields (library-wide) and, if the case has a template, that template's fields. Requires the Cases feature to be enabled in the space.

Path parameters

caseId string required

The identifier for the case. To retrieve case IDs, use the search cases (_find) API. All non-ASCII characters must be URL encoded.

Example: 9c235210-6834-11ea-a78c-6ffb38a34414

Responses

Indicates a successful call.

application/json
fields object[] required
control string required

The UI control for the field, such as INPUT_TEXT, INPUT_NUMBER, SELECT_BASIC, TOGGLE, or MARKDOWN.

defaultValue string

The default value, as a string, when the field definition declares one.

displayOnly boolean required

When true the field is display-only (for example a MARKDOWN block): it is returned so the full form shape is visible, but it holds no value and its key cannot be written to extended_fields.

isGlobal boolean required

Whether the field is a global (library-wide) definition.

key string required

The storage key to write in the case extended_fields map. Follows the <field_name>_as_<storage_type> convention (for example priority_as_keyword).

label string required

The human-readable label. Falls back to name when no label is authored.

name string required

The field name as authored in the field definition.

options string[]

The allowed values for SELECT_BASIC, RADIO_GROUP, and CHECKBOX_GROUP fields.

type string required

The storage type: keyword, integer, long, boolean, or date.

required boolean required

Whether a value must be supplied at write time.

requiredOnClose boolean required

Whether the field must be filled before the case can be closed.

source enum required

Where the field comes from: global for a library-wide (isGlobal) definition writable on any case, or template for a field contributed by the applied template.

Values: global template

Authorization information is missing or invalid.

application/json
error string
message string
statusCode integer

The user does not have access to the case.

application/json
error string
message string
statusCode integer

The case was not found.

application/json
error string
message string
statusCode integer
Base URL
https://{kibana_url}