Sign in
cases

Create a field definition

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Creates a field definition in the field library. You must have the "Manage templates" sub-privilege for the Cases feature of the owning solution. Requires the Cases feature to be enabled in the space. Use dry_run=true to validate the request without writing anything.

post/api/cases/field_definitions

Query parameters

dry_runboolean

When true, runs authorization, body, and name-uniqueness validation without creating the field definition. Returns { "valid": true } on success.

Request body

definitionstring required

The field definition as a YAML string describing a single field (type, label, control, metadata).

descriptionstring

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

isGlobalboolean

When true, this field is rendered in every case for this owner, regardless of the template used. Global fields cannot be demoted (set to false) while they are linked to an active custom field in the Cases configuration.

namestring

The field name, unique per owner (case-insensitive). Must match the name key inside the YAML definition. When omitted, the name is extracted from the definition YAML automatically. Immutable after creation.

ownerstring required

The application that owns this field definition.

Example request

{
  "definition": "name: priority\nlabel: Priority\ntype: keyword\ncontrol: SELECT_BASIC\nmetadata:\n  options: [low, medium, high]\n  default: medium\n"
}

Response

Indicates a successful call. Returns the created field definition, or { "valid": true } when dry_run=true.

OR

Changes

No changes recorded. 20 of the 176 revisions have no diff computed, so they could not be searched.