cases

Get the fields applicable to a case

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/cases/fields</span></div>

Refer to Spaces for more information.

Returns the fields you can write to a case's extended_fields when creating a case for the given owner. Includes the owner's global (library-wide) fields and, when templateId is supplied, that template's fields. Migrated legacy custom fields appear as global fields. Requires the Cases feature to be enabled in the space.

get/api/cases/fields

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/cases/fields
  • Auth
    • API key in header Authorization
    • or HTTP basic

Query parameters

ownerstring required

The application that owns the cases (for example cases, observability, or securitySolution).

templateIdstring

The identifier of a template to include the template's fields in the response.

Response

Indicates a successful call.

Example response

{
  "fields": [
    {
      "control": "SELECT_BASIC",
      "key": "priority_as_keyword",
      "label": "Priority",
      "name": "priority",
      "type": "keyword"
    }
  ]
}

Changes