API

Draft case types

Draft case types. This replaces or sets the selected state using the full supplied value.

Applies to: Next (0.1 RC1 Preview)
Product revision: 25748655d6be
Audience: Developers and integrators
Source reviewed: 2026-10-06

PUT/api/case-types/{caseTypeId}/draft

Preview

Draft case types. This replaces or sets the selected state using the full supplied value.

Operation ID putapiCaseTypesCaseTypeIdDraft

Operation details

Purpose

Draft case types. This replaces or sets the selected state using the full supplied value.

When to use it

Use this when the caller has read the current state and is authorised to change the documented fields or lifecycle state.

When not to use it

Do not use this to create an unrelated resource or bypass a purpose built transition, validation, or permission check operation.

Contract

Availability

Product version: Next Product release
Licence: An active Product licence is required except for health, authentication, and licence remediation operations.
Entitlements: workflow.enabled
Service roles: workflow
Deployment: customer managed installation
Feature state: preview

Security

Access

Sign in: Use a session cookie or Bearer session token.

Actor: Authenticated Pūnaha actor authorised for the selected tenant and resource
Permission: cases.manage
Resource: case_type / update / example casetypeid
Tenant rule: Tenant scoped unless the selected actor is performing an explicitly documented platform action. The x organization id header or authenticated session context selects the tenant. It does not grant access.
Explicit deny: An applicable explicit deny overrides an allow. Knowing or supplying a resource identifier never grants access.

Address, query and header fields

Field	Location	Presence	Type	Meaning	Limits and example
`x-request-id`	header	Optional	string	Optional caller supplied correlation identifier. Pūnaha returns the effective value in the response header.	Minimum length: 1. Maximum length: 200. Example: example request 001
`caseTypeId`	path	Required	string	The case type id that identifies the resource selected by this operation.	Minimum length: 1. Example: example casetypeid

Request body

Content type: application/json. Presence: Required.

Operation request. Every property documents omission, null, sensitivity, source, mutability, availability, access, and lifecycle semantics through JSON Schema and x punaha-* annotations.

Request fields182 documented fields

Request fields

Field	Presence	Type	Meaning	Empty and default	Limits and example	Access, sensitivity and lifecycle
`artifacts`	optional	list of `CaseworkCMMNArtifactRequest`	The artifacts associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`artifacts[].direction`	optional	string	The direction associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`artifacts[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`artifacts[].sourceRef`	optional	string	The source ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`artifacts[].targetRef`	optional	string	The target ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`artifacts[].text`	optional	string	The text associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`artifacts[].textFormat`	optional	string	The text format associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`artifacts[].type`	required	string	The type associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile`	optional	list of `CaseworkCaseFileItemDefinitionRequest`	The case file associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].definitionRef`	required	string	The definition ref associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].definitionType`	optional	string	The definition type associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].multiplicity`	required	string	The multiplicity associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].name`	required	string	The name associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].parentId`	optional	string	The parent id associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].properties`	optional	list of `CaseworkCaseFilePropertyRequest`	The properties associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].properties[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].properties[].name`	required	string	The name associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].properties[].type`	optional	string	The type associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].sourceRef`	optional	string	The source ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].structureRef`	optional	string	The structure ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`caseFile[].targetRefs`	optional	list of string	The target refs associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram`	optional	`CaseworkCMMNDiagramRequest`	The diagram associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.edges`	optional	list of `CaseworkCMMNEdgeRequest`	The edges associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.edges[].elementRef`	optional	string	The element ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.edges[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.edges[].sourceRef`	optional	string	The source ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.edges[].standardEventVisible`	optional	boolean	The standard event visible associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.edges[].targetRef`	optional	string	The target ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.edges[].waypoints`	required	list of `CaseworkCMMNWaypointRequest`	The waypoints associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.edges[].waypoints[].x`	required	number in `double` format	The x associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.edges[].waypoints[].y`	required	number in `double` format	The y associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.height`	optional	number in `double` format	The height associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.id`	optional	string	The stable identifier of this resource.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.name`	optional	string	The name associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.shapes`	optional	list of `CaseworkCMMNShapeRequest`	The shapes associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.shapes[].collapsed`	optional	boolean	The collapsed associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.shapes[].elementRef`	required	string	The element ref associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.shapes[].height`	required	number in `double` format	The height associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.shapes[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.shapes[].planningTableCollapsed`	optional	boolean	The planning table collapsed associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.shapes[].width`	required	number in `double` format	The width associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.shapes[].x`	required	number in `double` format	The x associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.shapes[].y`	required	number in `double` format	The y associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`diagram.width`	optional	number in `double` format	The width associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields`	required	list of `CaseworkFieldRequest`	The fields associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields[].description`	optional	string	The description associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields[].label`	required	string	The label associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields[].maximum`	optional	number in `double` format or null	The maximum associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields[].minimum`	optional	number in `double` format or null	The minimum associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1.5	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields[].options`	optional	list of string	The options associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields[].requiredAtStart`	optional	boolean	The required at start associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields[].sensitive`	optional	boolean	The sensitive associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`fields[].type`	required	string	The type associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`format`	required	string	The format associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`outcomes`	required	list of string	The outcomes associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`policies`	required	`CaseworkPoliciesRequest`	The policies associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`policies.allowReopen`	required	boolean	The allow reopen associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`policies.classification`	optional	string	The classification associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`policies.completionMode`	required	string	The completion mode associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`policies.retentionDays`	optional	integer in `int64` format	The retention days associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`purpose`	required	string	The purpose associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements`	required	list of `CaseworkRequirementRequest`	The requirements associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].appliesWhen`	optional	`CaseworkCriterionRequest` or null	The applies when associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].blocksCompletion`	required	boolean	The blocks completion associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].description`	optional	string	The description associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].due`	optional	`CaseworkDueRuleRequest` or null	The due associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].enforcement`	required	string	The enforcement associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].fieldId`	optional	string	The field id associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].milestoneId`	optional	string	The milestone id associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].name`	required	string	The name associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].planItemId`	optional	string	The plan item id associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].responsibleRole`	optional	string	The responsible role associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].stageId`	optional	string	The stage id associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].type`	required	string	The type associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].waivable`	required	boolean	The waivable associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`requirements[].waiverRole`	optional	string	The waiver role associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`roles`	required	list of `CaseworkRoleRequest`	The roles associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`roles[].description`	optional	string	The description associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`roles[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`roles[].name`	required	string	The name associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`schemaVersion`	required	integer in `int64` format	The schema version associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries`	optional	list of `CaseworkSentryRequest`	The sentries associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].ifPart`	optional	list of `CaseworkCriterionRequest`	The if part associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].ifPart[].expressionLanguage`	optional	string	The expression language associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].ifPart[].operator`	required	string	The operator associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].ifPart[].source`	required	string	The source associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].ifPart[].value`	optional	JSON value	A JSON value whose shape is explicitly determined by the selected configuration, provider, or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].name`	optional	string	The name associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].onParts`	optional	list of `CaseworkOnPartRequest`	The on parts associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].onParts[].exitCriterionRef`	optional	string	The exit criterion ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].onParts[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].onParts[].sourceRef`	required	string	The source ref associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].onParts[].sourceType`	required	string	The source type associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`sentries[].onParts[].standardEvent`	required	string	The standard event associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages`	required	list of `CaseworkStageRequest`	The stages associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].autoComplete`	optional	boolean	The auto complete associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].control`	optional	`CaseworkPlanItemControlRequest`	The control associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].control.manualActivation`	optional	`CaseworkControlRuleRequest` or null	The manual activation associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].control.repetition`	optional	`CaseworkControlRuleRequest` or null	The repetition associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].control.required`	optional	`CaseworkControlRuleRequest` or null	The required associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].description`	optional	string	The description associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].entryCriteria`	optional	list of `CaseworkCriterionRequest`	The entry criteria associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].entryCriteria[].expressionLanguage`	optional	string	The expression language associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].entryCriteria[].operator`	required	string	The operator associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].entryCriteria[].source`	required	string	The source associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].entryCriteria[].value`	optional	JSON value	A JSON value whose shape is explicitly determined by the selected configuration, provider, or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].entrySentryRefs`	optional	list of string	The entry sentry refs associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].exitCriteria`	optional	list of `CaseworkCriterionRequest`	The exit criteria associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].exitCriteria[].expressionLanguage`	optional	string	The expression language associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].exitCriteria[].operator`	required	string	The operator associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].exitCriteria[].source`	required	string	The source associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].exitCriteria[].value`	optional	JSON value	A JSON value whose shape is explicitly determined by the selected configuration, provider, or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].exitSentryRefs`	optional	list of string	The exit sentry refs associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items`	required	list of `CaseworkPlanItemRequest`	The records included in this collection.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].authorizedRoles`	optional	list of string	The authorized roles associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].blocking`	optional	boolean or null	The blocking associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].caseTypeId`	optional	string	The case type id associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].caseTypeVersion`	optional	integer in `int64` format	The case type version associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].children`	optional	list of `CaseworkPlanItemRequest`	The children associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].control`	optional	`CaseworkPlanItemControlRequest`	The control associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].control.manualActivation`	optional	`CaseworkControlRuleRequest` or null	The manual activation associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].control.repetition`	optional	`CaseworkControlRuleRequest` or null	The repetition associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].control.required`	optional	`CaseworkControlRuleRequest` or null	The required associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].correlationField`	optional	string	The correlation field associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].decision`	optional	`CaseworkDecisionTableRequest` or null	The decision associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].definitionRef`	optional	string	The definition ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].description`	optional	string	The description associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].due`	optional	`CaseworkDueRuleRequest` or null	The due associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].entryCriteria`	optional	list of `CaseworkCriterionRequest`	The entry criteria associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].entryCriteria[].expressionLanguage`	optional	string	The expression language associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].entryCriteria[].operator`	required	string	The operator associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].entryCriteria[].source`	required	string	The source associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].entryCriteria[].value`	optional	JSON value	A JSON value whose shape is explicitly determined by the selected configuration, provider, or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].entrySentryRefs`	optional	list of string	The entry sentry refs associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].eventType`	optional	string	The event type associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].exitCriteria`	optional	list of `CaseworkCriterionRequest`	The exit criteria associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].exitCriteria[].expressionLanguage`	optional	string	The expression language associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].exitCriteria[].operator`	required	string	The operator associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].exitCriteria[].source`	required	string	The source associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].exitCriteria[].value`	optional	JSON value	A JSON value whose shape is explicitly determined by the selected configuration, provider, or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].exitSentryRefs`	optional	list of string	The exit sentry refs associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].externalImportType`	optional	string	The external import type associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].externalLocation`	optional	string	The external location associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].externalNamespace`	optional	string	The external namespace associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].externalPrefix`	optional	string	The external prefix associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].externalRef`	optional	string	The external ref associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].implementationType`	optional	string	The implementation type associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].input`	optional	object	Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: {}	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].inputMappings`	optional	list of `CaseworkParameterMappingRequest`	The input mappings associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].inputMappings[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].inputMappings[].source`	required	string	The source associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].inputMappings[].target`	required	string	The target associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].inputMappings[].transformation`	optional	string	The transformation associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].manualActivation`	optional	boolean	The manual activation associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].name`	required	string	The name associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].outputMappings`	optional	list of `CaseworkParameterMappingRequest`	The output mappings associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].outputMappings[].id`	required	string	The stable identifier of this resource.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].outputMappings[].source`	required	string	The source associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].outputMappings[].target`	required	string	The target associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].outputMappings[].transformation`	optional	string	The transformation associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].planningTable`	optional	`CaseworkPlanningTableRequest` or null	The planning table associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].repeatable`	optional	boolean	The repeatable associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].required`	required	boolean	The required associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].roleId`	optional	string	The role id associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].timeoutMinutes`	optional	integer in `int64` format	The timeout minutes associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].timerExpression`	optional	string	The timer expression associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].timerStart`	optional	`CaseworkOnPartRequest` or null	The timer start associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].type`	required	string	The type associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].workflowId`	optional	string	The workflow id associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].items[].workflowVersion`	optional	integer in `int64` format	The workflow version associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: 1	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].manualActivation`	optional	boolean	The manual activation associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].name`	required	string	The name associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].parentId`	optional	string	The parent id associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].planningTable`	optional	`CaseworkPlanningTableRequest` or null	The planning table associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	No additional schema limit is listed	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].repeatable`	optional	boolean	The repeatable associated with this resource or operation.	The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.
`stages[].required`	required	boolean	The required associated with this resource or operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: Yes	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.

Complete representative request using synthetic data

{
  "artifacts": [
    {
      "direction": "example-value",
      "id": "example-value",
      "sourceRef": "example-value",
      "targetRef": "example-value",
      "text": "example-value",
      "textFormat": "example-value",
      "type": "example-value"
    }
  ],
  "caseFile": [
    {
      "definitionRef": "example-value",
      "definitionType": "example-value",
      "id": "example-value",
      "multiplicity": "example-value",
      "name": "example-value",
      "parentId": "example-value",
      "properties": [
        {
          "id": "example-value",
          "name": "example-value",
          "type": "example-value"
        }
      ],
      "sourceRef": "example-value",
      "structureRef": "example-value",
      "targetRefs": [
        "example-value"
      ]
    }
  ],
  "diagram": {
    "edges": [
      {
        "elementRef": "example-value",
        "id": "example-value",
        "sourceRef": "example-value",
        "standardEventVisible": true,
        "targetRef": "example-value",
        "waypoints": [
          {
            "x": 1.5,
            "y": 1.5
          }
        ]
      }
    ],
    "height": 1.5,
    "id": "example-value",
    "name": "example-value",
    "shapes": [
      {
        "collapsed": true,
        "elementRef": "example-value",
        "height": 1.5,
        "id": "example-value",
        "planningTableCollapsed": true,
        "width": 1.5,
        "x": 1.5,
        "y": 1.5
      }
    ],
    "width": 1.5
  },
  "fields": [
    {
      "description": "example-value",
      "id": "example-value",
      "label": "example-value",
      "maximum": 1.5,
      "minimum": 1.5,
      "options": [
        "example-value"
      ],
      "requiredAtStart": true,
      "sensitive": true,
      "type": "example-value"
    }
  ],
  "format": "example-value",
  "outcomes": [
    "example-value"
  ],
  "policies": {
    "allowReopen": true,
    "classification": "example-value",
    "completionMode": "example-value",
    "retentionDays": 1
  },
  "purpose": "example-value",
  "requirements": [
    {
      "appliesWhen": {
        "expressionLanguage": "example-value",
        "operator": "example-value",
        "source": "example-value",
        "value": "example-value"
      },
      "blocksCompletion": true,
      "description": "example-value",
      "due": {
        "amount": 1,
        "from": "example-value",
        "unit": "example-value"
      },
      "enforcement": "example-value",
      "fieldId": "example-value",
      "id": "example-value",
      "milestoneId": "example-value",
      "name": "example-value",
      "planItemId": "example-value",
      "responsibleRole": "example-value",
      "stageId": "example-value",
      "type": "example-value",
      "waivable": true,
      "waiverRole": "example-value"
    }
  ],
  "roles": [
    {
      "description": "example-value",
      "id": "example-value",
      "name": "example-value"
    }
  ],
  "schemaVersion": 1,
  "sentries": [
    {
      "id": "example-value",
      "ifPart": [
        {
          "expressionLanguage": "example-value",
          "operator": "example-value",
          "source": "example-value",
          "value": "example-value"
        }
      ],
      "name": "example-value",
      "onParts": [
        {
          "exitCriterionRef": "example-value",
          "id": "example-value",
          "sourceRef": "example-value",
          "sourceType": "example-value",
          "standardEvent": "example-value"
        }
      ]
    }
  ],
  "stages": [
    {
      "autoComplete": true,
      "control": {
        "manualActivation": {
          "condition": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "sentryRef": "example-value"
        },
        "repetition": {
          "condition": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "sentryRef": "example-value"
        },
        "required": {
          "condition": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "sentryRef": "example-value"
        }
      },
      "description": "example-value",
      "entryCriteria": [
        {
          "expressionLanguage": "example-value",
          "operator": "example-value",
          "source": "example-value",
          "value": "example-value"
        }
      ],
      "entrySentryRefs": [
        "example-value"
      ],
      "exitCriteria": [
        {
          "expressionLanguage": "example-value",
          "operator": "example-value",
          "source": "example-value",
          "value": "example-value"
        }
      ],
      "exitSentryRefs": [
        "example-value"
      ],
      "id": "example-value",
      "items": [
        {
          "authorizedRoles": [
            "example-value"
          ],
          "blocking": true,
          "caseTypeId": "example-value",
          "caseTypeVersion": 1,
          "children": [
            {}
          ],
          "control": {
            "manualActivation": {
              "condition": [
                {
                  "expressionLanguage": "example-value",
                  "operator": "example-value",
                  "source": "example-value",
                  "value": "example-value"
                }
              ],
              "sentryRef": "example-value"
            },
            "repetition": {
              "condition": [
                {
                  "expressionLanguage": "example-value",
                  "operator": "example-value",
                  "source": "example-value",
                  "value": "example-value"
                }
              ],
              "sentryRef": "example-value"
            },
            "required": {
              "condition": [
                {
                  "expressionLanguage": "example-value",
                  "operator": "example-value",
                  "source": "example-value",
                  "value": "example-value"
                }
              ],
              "sentryRef": "example-value"
            }
          },
          "correlationField": "example-value",
          "decision": {
            "hitPolicy": "example-value",
            "id": "example-value",
            "inputs": [
              {
                "id": "example-value",
                "label": "example-value"
              }
            ],
            "name": "example-value",
            "outputs": [
              {
                "id": "example-value",
                "label": "example-value"
              }
            ],
            "rules": [
              {
                "conditions": {},
                "id": "example-value",
                "outputs": {}
              }
            ]
          },
          "definitionRef": "example-value",
          "description": "example-value",
          "due": {
            "amount": 1,
            "from": "example-value",
            "unit": "example-value"
          },
          "entryCriteria": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "entrySentryRefs": [
            "example-value"
          ],
          "eventType": "example-value",
          "exitCriteria": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "exitSentryRefs": [
            "example-value"
          ],
          "externalImportType": "example-value",
          "externalLocation": "example-value",
          "externalNamespace": "example-value",
          "externalPrefix": "example-value",
          "externalRef": "example-value",
          "id": "example-value",
          "implementationType": "example-value",
          "input": {},
          "inputMappings": [
            {
              "id": "example-value",
              "source": "example-value",
              "target": "example-value",
              "transformation": "example-value"
            }
          ],
          "manualActivation": true,
          "name": "example-value",
          "outputMappings": [
            {
              "id": "example-value",
              "source": "example-value",
              "target": "example-value",
              "transformation": "example-value"
            }
          ],
          "planningTable": {
            "applicabilityRules": [
              {
                "expressionLanguage": "example-value",
                "operator": "example-value",
                "source": "example-value",
                "value": "example-value"
              }
            ],
            "authorizedRoles": [
              "example-value"
            ],
            "id": "example-value",
            "itemRefs": [
              "example-value"
            ],
            "name": "example-value",
            "tables": [
              {}
            ]
          },
          "repeatable": true,
          "required": true,
          "roleId": "example-value",
          "timeoutMinutes": 1,
          "timerExpression": "example-value",
          "timerStart": {
            "exitCriterionRef": "example-value",
            "id": "example-value",
            "sourceRef": "example-value",
            "sourceType": "example-value",
            "standardEvent": "example-value"
          },
          "type": "example-value",
          "workflowId": "example-value",
          "workflowVersion": 1
        }
      ],
      "manualActivation": true,
      "name": "example-value",
      "parentId": "example-value",
      "planningTable": {
        "applicabilityRules": [
          {
            "expressionLanguage": "example-value",
            "operator": "example-value",
            "source": "example-value",
            "value": "example-value"
          }
        ],
        "authorizedRoles": [
          "example-value"
        ],
        "id": "example-value",
        "itemRefs": [
          "example-value"
        ],
        "name": "example-value",
        "tables": [
          {}
        ]
      },
      "repeatable": true,
      "required": true
    }
  ]
}

Smallest schema valid request

{
  "fields": [
    {
      "id": "example-value",
      "label": "example-value",
      "type": "example-value"
    }
  ],
  "format": "example-value",
  "outcomes": [
    "example-value"
  ],
  "policies": {
    "allowReopen": true,
    "completionMode": "example-value"
  },
  "purpose": "example-value",
  "requirements": [
    {
      "blocksCompletion": true,
      "enforcement": "example-value",
      "id": "example-value",
      "name": "example-value",
      "type": "example-value",
      "waivable": true
    }
  ],
  "roles": [
    {
      "id": "example-value",
      "name": "example-value"
    }
  ],
  "schemaVersion": 1,
  "stages": [
    {
      "id": "example-value",
      "items": [
        {
          "id": "example-value",
          "name": "example-value",
          "required": true,
          "type": "example-value"
        }
      ],
      "name": "example-value",
      "required": true
    }
  ]
}

Responses

Status	Meaning and correction boundary	Body
`200`	The operation completed and the response contains the current operation specific representation.	`application/json`, object
`400`	The operation failed with HTTP 400. Inspect error.code and error.details, apply the documented correction, and retain x request id.	`application/json`, `APIError`
`401`	The operation failed with HTTP 401. Inspect error.code and error.details, apply the documented correction, and retain x request id.	`application/json`, `APIError`
`402`	The operation failed with HTTP 402. Inspect error.code and error.details, apply the documented correction, and retain x request id.	`application/json`, `APIError`
`403`	The operation failed with HTTP 403. Inspect error.code and error.details, apply the documented correction, and retain x request id.	`application/json`, `APIError`
`404`	The operation failed with HTTP 404. Inspect error.code and error.details, apply the documented correction, and retain x request id.	`application/json`, `APIError`
`409`	The operation failed with HTTP 409. Inspect error.code and error.details, apply the documented correction, and retain x request id.	`application/json`, `APIError`
`423`	The operation failed with HTTP 423. Inspect error.code and error.details, apply the documented correction, and retain x request id.	`application/json`, `APIError`
`500`	The operation failed with HTTP 500. Inspect error.code and error.details, apply the documented correction, and retain x request id.	`application/json`, `APIError`
`503`	The operation failed with HTTP 503. Inspect error.code and error.details, apply the documented correction, and retain x request id.	`application/json`, `APIError`

200 response fields1 documented field

200 response fields

Field	Presence	Type	Meaning	Empty and default	Limits and example	Access, sensitivity and lifecycle
`data`	required	JSON value	A JSON compatible value returned by this operation.	The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present.	Example: example value	Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release.

Successful response using synthetic data

{
  "data": "example-value"
}

Effects

Behaviour and other effects

Changes: Validates access and input, then applies the operation specific state change. A failed validation or authorisation check does not intentionally apply the requested change.
Audit events: case_type.draft_saved
Background work: No background work is inferred. The success response represents completion of the HTTP action.
External effects: No external call is inferred from the route name. Operation specific service behaviour remains authoritative.
Transaction boundary: The HTTP success or error describes the synchronous boundary. Background operations have their own observable lifecycle and may outlive the request.

Operation

Reliability

Idempotent: Yes
Retry: A retry is normally safe only with the same resource, body, tenant, and concurrency preconditions. Confirm the first outcome when external effects are possible.
Concurrency: Use documented If Match or resource revision fields where exposed. Otherwise read current state before changing it and handle HTTP 409 conflicts.
Consistency: The response reflects the synchronous operation boundary. Background and provider backed state can converge later and must be read through its status operation.
Timeout: Client timeouts do not cancel completed or already started server work unless the operation explicitly supports cancellation.
Request ID: Send or record x request id and retain the returned value for diagnosis.

Errors and corrections

Status	Code	Cause	Correction	Retryable	Partial work
`400`	`INVALID_REQUEST_BODY`	The request body or supplied field values are invalid.	Correct the named field or rule in error.details, then submit a new request. Retrying an unchanged request will not help.	No unchanged retry	No requested mutation is expected before this failure boundary.
`401`	`AUTHENTICATION_REQUIRED`	A valid authenticated session or supported token is required.	Authenticate again using a supported mechanism and confirm that the credential is current.	No unchanged retry	No requested mutation is expected before this failure boundary.
`402`	`FEATURE_NOT_LICENSED`	The active licence does not include a required entitlement.	Use an operation covered by the active entitlement or ask the System Owner to review the signed licence.	No unchanged retry	No requested mutation is expected before this failure boundary.
`403`	`PERMISSION_REQUIRED`	The authenticated actor does not have the exact permission or resource action.	Select the correct tenant and resource, then ask an authorised administrator to grant the exact documented action if appropriate.	No unchanged retry	No requested mutation is expected before this failure boundary.
`404`	`NOT_FOUND`	The selected resource does not exist in the authorised scope.	Obtain the identifier from the related list or create operation and confirm the selected tenant.	No unchanged retry	No requested mutation is expected before this failure boundary.
`409`	`STATE_CONFLICT`	Current resource state or a dependency prevents the requested change.	Read current state, resolve the named dependency or lifecycle conflict, and submit a deliberate new request.	No unchanged retry	The caller must read current resource or background operation state before retrying because work may have started before the failure became observable.
`423`	`LICENCE_REMEDIATION_REQUIRED`	The installation is restricted and permits only licence remediation actions.	Complete the indicated licence or membership remediation before retrying Product work.	No unchanged retry	The caller must read current resource or background operation state before retrying because work may have started before the failure became observable.
`500`	`INTERNAL_ERROR`	Pūnaha could not complete the operation because of an unexpected internal failure.	Retain x request id and the stable error code, avoid blind retries, and investigate the operation or contact support. Code: INTERNAL_ERROR.	No unchanged retry	The caller must read current resource or background operation state before retrying because work may have started before the failure became observable.
`503`	`DEPENDENCY_UNAVAILABLE`	A required node, database, provider, or service is temporarily unavailable.	Retain x request id, check health and the named dependency, then retry with bounded backoff when safe.	Yes, with the documented safeguards	The caller must read current resource or background operation state before retrying because work may have started before the failure became observable.

Code examples

Use a supported credential and synthetic data. Do not disable TLS checks or retry a request that changes state blindly.

cURL example

curl --request PUT "$PUNAHA_URL/api/case-types/example-casetypeid/draft" \
  --header "Authorization: Bearer $PUNAHA_TOKEN" \
  --header "x-request-id: example-request-001" \
  --header "Content-Type: application/json" \
  --data '{"artifacts":[{"direction":"example-value","id":"example-value","sourceRef":"example-value","targetRef":"example-value","text":"example-value","textFormat":"example-value","type":"example-value"}],"caseFile":[{"definitionRef":"example-value","definitionType":"example-value","id":"example-value","multiplicity":"example-value","name":"example-value","parentId":"example-value","properties":[{"id":"example-value","name":"example-value","type":"example-value"}],"sourceRef":"example-value","structureRef":"example-value","targetRefs":["example-value"]}],"diagram":{"edges":[{"elementRef":"example-value","id":"example-value","sourceRef":"example-value","standardEventVisible":true,"targetRef":"example-value","waypoints":[{"x":1.5,"y":1.5}]}],"height":1.5,"id":"example-value","name":"example-value","shapes":[{"collapsed":true,"elementRef":"example-value","height":1.5,"id":"example-value","planningTableCollapsed":true,"width":1.5,"x":1.5,"y":1.5}],"width":1.5},"fields":[{"description":"example-value","id":"example-value","label":"example-value","maximum":1.5,"minimum":1.5,"options":["example-value"],"requiredAtStart":true,"sensitive":true,"type":"example-value"}],"format":"example-value","outcomes":["example-value"],"policies":{"allowReopen":true,"classification":"example-value","completionMode":"example-value","retentionDays":1},"purpose":"example-value","requirements":[{"appliesWhen":{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"},"blocksCompletion":true,"description":"example-value","due":{"amount":1,"from":"example-value","unit":"example-value"},"enforcement":"example-value","fieldId":"example-value","id":"example-value","milestoneId":"example-value","name":"example-value","planItemId":"example-value","responsibleRole":"example-value","stageId":"example-value","type":"example-value","waivable":true,"waiverRole":"example-value"}],"roles":[{"description":"example-value","id":"example-value","name":"example-value"}],"schemaVersion":1,"sentries":[{"id":"example-value","ifPart":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"name":"example-value","onParts":[{"exitCriterionRef":"example-value","id":"example-value","sourceRef":"example-value","sourceType":"example-value","standardEvent":"example-value"}]}],"stages":[{"autoComplete":true,"control":{"manualActivation":{"condition":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"sentryRef":"example-value"},"repetition":{"condition":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"sentryRef":"example-value"},"required":{"condition":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"sentryRef":"example-value"}},"description":"example-value","entryCriteria":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"entrySentryRefs":["example-value"],"exitCriteria":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"exitSentryRefs":["example-value"],"id":"example-value","items":[{"authorizedRoles":["example-value"],"blocking":true,"caseTypeId":"example-value","caseTypeVersion":1,"children":[{}],"control":{"manualActivation":{"condition":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"sentryRef":"example-value"},"repetition":{"condition":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"sentryRef":"example-value"},"required":{"condition":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"sentryRef":"example-value"}},"correlationField":"example-value","decision":{"hitPolicy":"example-value","id":"example-value","inputs":[{"id":"example-value","label":"example-value"}],"name":"example-value","outputs":[{"id":"example-value","label":"example-value"}],"rules":[{"conditions":{},"id":"example-value","outputs":{}}]},"definitionRef":"example-value","description":"example-value","due":{"amount":1,"from":"example-value","unit":"example-value"},"entryCriteria":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"entrySentryRefs":["example-value"],"eventType":"example-value","exitCriteria":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"exitSentryRefs":["example-value"],"externalImportType":"example-value","externalLocation":"example-value","externalNamespace":"example-value","externalPrefix":"example-value","externalRef":"example-value","id":"example-value","implementationType":"example-value","input":{},"inputMappings":[{"id":"example-value","source":"example-value","target":"example-value","transformation":"example-value"}],"manualActivation":true,"name":"example-value","outputMappings":[{"id":"example-value","source":"example-value","target":"example-value","transformation":"example-value"}],"planningTable":{"applicabilityRules":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"authorizedRoles":["example-value"],"id":"example-value","itemRefs":["example-value"],"name":"example-value","tables":[{}]},"repeatable":true,"required":true,"roleId":"example-value","timeoutMinutes":1,"timerExpression":"example-value","timerStart":{"exitCriterionRef":"example-value","id":"example-value","sourceRef":"example-value","sourceType":"example-value","standardEvent":"example-value"},"type":"example-value","workflowId":"example-value","workflowVersion":1}],"manualActivation":true,"name":"example-value","parentId":"example-value","planningTable":{"applicabilityRules":[{"expressionLanguage":"example-value","operator":"example-value","source":"example-value","value":"example-value"}],"authorizedRoles":["example-value"],"id":"example-value","itemRefs":["example-value"],"name":"example-value","tables":[{}]},"repeatable":true,"required":true}]}'

JavaScript example

const response = await fetch(`${PUNAHA_URL}/api/case-types/example-casetypeid/draft`, {
  method: "PUT",
  headers: {
  "x-request-id": "example-request-001",
  "Authorization": "Bearer ${PUNAHA_TOKEN}",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
    "artifacts": [
      {
        "direction": "example-value",
        "id": "example-value",
        "sourceRef": "example-value",
        "targetRef": "example-value",
        "text": "example-value",
        "textFormat": "example-value",
        "type": "example-value"
      }
    ],
    "caseFile": [
      {
        "definitionRef": "example-value",
        "definitionType": "example-value",
        "id": "example-value",
        "multiplicity": "example-value",
        "name": "example-value",
        "parentId": "example-value",
        "properties": [
          {
            "id": "example-value",
            "name": "example-value",
            "type": "example-value"
          }
        ],
        "sourceRef": "example-value",
        "structureRef": "example-value",
        "targetRefs": [
          "example-value"
        ]
      }
    ],
    "diagram": {
      "edges": [
        {
          "elementRef": "example-value",
          "id": "example-value",
          "sourceRef": "example-value",
          "standardEventVisible": true,
          "targetRef": "example-value",
          "waypoints": [
            {
              "x": 1.5,
              "y": 1.5
            }
          ]
        }
      ],
      "height": 1.5,
      "id": "example-value",
      "name": "example-value",
      "shapes": [
        {
          "collapsed": true,
          "elementRef": "example-value",
          "height": 1.5,
          "id": "example-value",
          "planningTableCollapsed": true,
          "width": 1.5,
          "x": 1.5,
          "y": 1.5
        }
      ],
      "width": 1.5
    },
    "fields": [
      {
        "description": "example-value",
        "id": "example-value",
        "label": "example-value",
        "maximum": 1.5,
        "minimum": 1.5,
        "options": [
          "example-value"
        ],
        "requiredAtStart": true,
        "sensitive": true,
        "type": "example-value"
      }
    ],
    "format": "example-value",
    "outcomes": [
      "example-value"
    ],
    "policies": {
      "allowReopen": true,
      "classification": "example-value",
      "completionMode": "example-value",
      "retentionDays": 1
    },
    "purpose": "example-value",
    "requirements": [
      {
        "appliesWhen": {
          "expressionLanguage": "example-value",
          "operator": "example-value",
          "source": "example-value",
          "value": "example-value"
        },
        "blocksCompletion": true,
        "description": "example-value",
        "due": {
          "amount": 1,
          "from": "example-value",
          "unit": "example-value"
        },
        "enforcement": "example-value",
        "fieldId": "example-value",
        "id": "example-value",
        "milestoneId": "example-value",
        "name": "example-value",
        "planItemId": "example-value",
        "responsibleRole": "example-value",
        "stageId": "example-value",
        "type": "example-value",
        "waivable": true,
        "waiverRole": "example-value"
      }
    ],
    "roles": [
      {
        "description": "example-value",
        "id": "example-value",
        "name": "example-value"
      }
    ],
    "schemaVersion": 1,
    "sentries": [
      {
        "id": "example-value",
        "ifPart": [
          {
            "expressionLanguage": "example-value",
            "operator": "example-value",
            "source": "example-value",
            "value": "example-value"
          }
        ],
        "name": "example-value",
        "onParts": [
          {
            "exitCriterionRef": "example-value",
            "id": "example-value",
            "sourceRef": "example-value",
            "sourceType": "example-value",
            "standardEvent": "example-value"
          }
        ]
      }
    ],
    "stages": [
      {
        "autoComplete": true,
        "control": {
          "manualActivation": {
            "condition": [
              {
                "expressionLanguage": "example-value",
                "operator": "example-value",
                "source": "example-value",
                "value": "example-value"
              }
            ],
            "sentryRef": "example-value"
          },
          "repetition": {
            "condition": [
              {
                "expressionLanguage": "example-value",
                "operator": "example-value",
                "source": "example-value",
                "value": "example-value"
              }
            ],
            "sentryRef": "example-value"
          },
          "required": {
            "condition": [
              {
                "expressionLanguage": "example-value",
                "operator": "example-value",
                "source": "example-value",
                "value": "example-value"
              }
            ],
            "sentryRef": "example-value"
          }
        },
        "description": "example-value",
        "entryCriteria": [
          {
            "expressionLanguage": "example-value",
            "operator": "example-value",
            "source": "example-value",
            "value": "example-value"
          }
        ],
        "entrySentryRefs": [
          "example-value"
        ],
        "exitCriteria": [
          {
            "expressionLanguage": "example-value",
            "operator": "example-value",
            "source": "example-value",
            "value": "example-value"
          }
        ],
        "exitSentryRefs": [
          "example-value"
        ],
        "id": "example-value",
        "items": [
          {
            "authorizedRoles": [
              "example-value"
            ],
            "blocking": true,
            "caseTypeId": "example-value",
            "caseTypeVersion": 1,
            "children": [
              {}
            ],
            "control": {
              "manualActivation": {
                "condition": [
                  {
                    "expressionLanguage": "example-value",
                    "operator": "example-value",
                    "source": "example-value",
                    "value": "example-value"
                  }
                ],
                "sentryRef": "example-value"
              },
              "repetition": {
                "condition": [
                  {
                    "expressionLanguage": "example-value",
                    "operator": "example-value",
                    "source": "example-value",
                    "value": "example-value"
                  }
                ],
                "sentryRef": "example-value"
              },
              "required": {
                "condition": [
                  {
                    "expressionLanguage": "example-value",
                    "operator": "example-value",
                    "source": "example-value",
                    "value": "example-value"
                  }
                ],
                "sentryRef": "example-value"
              }
            },
            "correlationField": "example-value",
            "decision": {
              "hitPolicy": "example-value",
              "id": "example-value",
              "inputs": [
                {
                  "id": "example-value",
                  "label": "example-value"
                }
              ],
              "name": "example-value",
              "outputs": [
                {
                  "id": "example-value",
                  "label": "example-value"
                }
              ],
              "rules": [
                {
                  "conditions": {},
                  "id": "example-value",
                  "outputs": {}
                }
              ]
            },
            "definitionRef": "example-value",
            "description": "example-value",
            "due": {
              "amount": 1,
              "from": "example-value",
              "unit": "example-value"
            },
            "entryCriteria": [
              {
                "expressionLanguage": "example-value",
                "operator": "example-value",
                "source": "example-value",
                "value": "example-value"
              }
            ],
            "entrySentryRefs": [
              "example-value"
            ],
            "eventType": "example-value",
            "exitCriteria": [
              {
                "expressionLanguage": "example-value",
                "operator": "example-value",
                "source": "example-value",
                "value": "example-value"
              }
            ],
            "exitSentryRefs": [
              "example-value"
            ],
            "externalImportType": "example-value",
            "externalLocation": "example-value",
            "externalNamespace": "example-value",
            "externalPrefix": "example-value",
            "externalRef": "example-value",
            "id": "example-value",
            "implementationType": "example-value",
            "input": {},
            "inputMappings": [
              {
                "id": "example-value",
                "source": "example-value",
                "target": "example-value",
                "transformation": "example-value"
              }
            ],
            "manualActivation": true,
            "name": "example-value",
            "outputMappings": [
              {
                "id": "example-value",
                "source": "example-value",
                "target": "example-value",
                "transformation": "example-value"
              }
            ],
            "planningTable": {
              "applicabilityRules": [
                {
                  "expressionLanguage": "example-value",
                  "operator": "example-value",
                  "source": "example-value",
                  "value": "example-value"
                }
              ],
              "authorizedRoles": [
                "example-value"
              ],
              "id": "example-value",
              "itemRefs": [
                "example-value"
              ],
              "name": "example-value",
              "tables": [
                {}
              ]
            },
            "repeatable": true,
            "required": true,
            "roleId": "example-value",
            "timeoutMinutes": 1,
            "timerExpression": "example-value",
            "timerStart": {
              "exitCriterionRef": "example-value",
              "id": "example-value",
              "sourceRef": "example-value",
              "sourceType": "example-value",
              "standardEvent": "example-value"
            },
            "type": "example-value",
            "workflowId": "example-value",
            "workflowVersion": 1
          }
        ],
        "manualActivation": true,
        "name": "example-value",
        "parentId": "example-value",
        "planningTable": {
          "applicabilityRules": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "authorizedRoles": [
            "example-value"
          ],
          "id": "example-value",
          "itemRefs": [
            "example-value"
          ],
          "name": "example-value",
          "tables": [
            {}
          ]
        },
        "repeatable": true,
        "required": true
      }
    ]
  })
});

if (!response.ok) throw new Error(`Pūnaha request failed: ${response.status}`);
const result = response.status === 204 ? undefined : await response.json();

C# example

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient { BaseAddress = new Uri(punahaUrl) };
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", punahaToken);
using var request = new HttpRequestMessage(HttpMethod.Put, "/api/case-types/example-casetypeid/draft");
request.Headers.Add("x-request-id", "example-request-001");
var json = "{\"artifacts\":[{\"direction\":\"example-value\",\"id\":\"example-value\",\"sourceRef\":\"example-value\",\"targetRef\":\"example-value\",\"text\":\"example-value\",\"textFormat\":\"example-value\",\"type\":\"example-value\"}],\"caseFile\":[{\"definitionRef\":\"example-value\",\"definitionType\":\"example-value\",\"id\":\"example-value\",\"multiplicity\":\"example-value\",\"name\":\"example-value\",\"parentId\":\"example-value\",\"properties\":[{\"id\":\"example-value\",\"name\":\"example-value\",\"type\":\"example-value\"}],\"sourceRef\":\"example-value\",\"structureRef\":\"example-value\",\"targetRefs\":[\"example-value\"]}],\"diagram\":{\"edges\":[{\"elementRef\":\"example-value\",\"id\":\"example-value\",\"sourceRef\":\"example-value\",\"standardEventVisible\":true,\"targetRef\":\"example-value\",\"waypoints\":[{\"x\":1.5,\"y\":1.5}]}],\"height\":1.5,\"id\":\"example-value\",\"name\":\"example-value\",\"shapes\":[{\"collapsed\":true,\"elementRef\":\"example-value\",\"height\":1.5,\"id\":\"example-value\",\"planningTableCollapsed\":true,\"width\":1.5,\"x\":1.5,\"y\":1.5}],\"width\":1.5},\"fields\":[{\"description\":\"example-value\",\"id\":\"example-value\",\"label\":\"example-value\",\"maximum\":1.5,\"minimum\":1.5,\"options\":[\"example-value\"],\"requiredAtStart\":true,\"sensitive\":true,\"type\":\"example-value\"}],\"format\":\"example-value\",\"outcomes\":[\"example-value\"],\"policies\":{\"allowReopen\":true,\"classification\":\"example-value\",\"completionMode\":\"example-value\",\"retentionDays\":1},\"purpose\":\"example-value\",\"requirements\":[{\"appliesWhen\":{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"},\"blocksCompletion\":true,\"description\":\"example-value\",\"due\":{\"amount\":1,\"from\":\"example-value\",\"unit\":\"example-value\"},\"enforcement\":\"example-value\",\"fieldId\":\"example-value\",\"id\":\"example-value\",\"milestoneId\":\"example-value\",\"name\":\"example-value\",\"planItemId\":\"example-value\",\"responsibleRole\":\"example-value\",\"stageId\":\"example-value\",\"type\":\"example-value\",\"waivable\":true,\"waiverRole\":\"example-value\"}],\"roles\":[{\"description\":\"example-value\",\"id\":\"example-value\",\"name\":\"example-value\"}],\"schemaVersion\":1,\"sentries\":[{\"id\":\"example-value\",\"ifPart\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"name\":\"example-value\",\"onParts\":[{\"exitCriterionRef\":\"example-value\",\"id\":\"example-value\",\"sourceRef\":\"example-value\",\"sourceType\":\"example-value\",\"standardEvent\":\"example-value\"}]}],\"stages\":[{\"autoComplete\":true,\"control\":{\"manualActivation\":{\"condition\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"sentryRef\":\"example-value\"},\"repetition\":{\"condition\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"sentryRef\":\"example-value\"},\"required\":{\"condition\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"sentryRef\":\"example-value\"}},\"description\":\"example-value\",\"entryCriteria\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"entrySentryRefs\":[\"example-value\"],\"exitCriteria\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"exitSentryRefs\":[\"example-value\"],\"id\":\"example-value\",\"items\":[{\"authorizedRoles\":[\"example-value\"],\"blocking\":true,\"caseTypeId\":\"example-value\",\"caseTypeVersion\":1,\"children\":[{}],\"control\":{\"manualActivation\":{\"condition\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"sentryRef\":\"example-value\"},\"repetition\":{\"condition\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"sentryRef\":\"example-value\"},\"required\":{\"condition\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"sentryRef\":\"example-value\"}},\"correlationField\":\"example-value\",\"decision\":{\"hitPolicy\":\"example-value\",\"id\":\"example-value\",\"inputs\":[{\"id\":\"example-value\",\"label\":\"example-value\"}],\"name\":\"example-value\",\"outputs\":[{\"id\":\"example-value\",\"label\":\"example-value\"}],\"rules\":[{\"conditions\":{},\"id\":\"example-value\",\"outputs\":{}}]},\"definitionRef\":\"example-value\",\"description\":\"example-value\",\"due\":{\"amount\":1,\"from\":\"example-value\",\"unit\":\"example-value\"},\"entryCriteria\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"entrySentryRefs\":[\"example-value\"],\"eventType\":\"example-value\",\"exitCriteria\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"exitSentryRefs\":[\"example-value\"],\"externalImportType\":\"example-value\",\"externalLocation\":\"example-value\",\"externalNamespace\":\"example-value\",\"externalPrefix\":\"example-value\",\"externalRef\":\"example-value\",\"id\":\"example-value\",\"implementationType\":\"example-value\",\"input\":{},\"inputMappings\":[{\"id\":\"example-value\",\"source\":\"example-value\",\"target\":\"example-value\",\"transformation\":\"example-value\"}],\"manualActivation\":true,\"name\":\"example-value\",\"outputMappings\":[{\"id\":\"example-value\",\"source\":\"example-value\",\"target\":\"example-value\",\"transformation\":\"example-value\"}],\"planningTable\":{\"applicabilityRules\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"authorizedRoles\":[\"example-value\"],\"id\":\"example-value\",\"itemRefs\":[\"example-value\"],\"name\":\"example-value\",\"tables\":[{}]},\"repeatable\":true,\"required\":true,\"roleId\":\"example-value\",\"timeoutMinutes\":1,\"timerExpression\":\"example-value\",\"timerStart\":{\"exitCriterionRef\":\"example-value\",\"id\":\"example-value\",\"sourceRef\":\"example-value\",\"sourceType\":\"example-value\",\"standardEvent\":\"example-value\"},\"type\":\"example-value\",\"workflowId\":\"example-value\",\"workflowVersion\":1}],\"manualActivation\":true,\"name\":\"example-value\",\"parentId\":\"example-value\",\"planningTable\":{\"applicabilityRules\":[{\"expressionLanguage\":\"example-value\",\"operator\":\"example-value\",\"source\":\"example-value\",\"value\":\"example-value\"}],\"authorizedRoles\":[\"example-value\"],\"id\":\"example-value\",\"itemRefs\":[\"example-value\"],\"name\":\"example-value\",\"tables\":[{}]},\"repeatable\":true,\"required\":true}]}";
request.Content = new StringContent(json, Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

PowerShell example

$headers = @{ Authorization = "Bearer $env:PUNAHA_TOKEN"; "x-request-id" = "example-request-001" }
$body = @'
{
  "artifacts": [
    {
      "direction": "example-value",
      "id": "example-value",
      "sourceRef": "example-value",
      "targetRef": "example-value",
      "text": "example-value",
      "textFormat": "example-value",
      "type": "example-value"
    }
  ],
  "caseFile": [
    {
      "definitionRef": "example-value",
      "definitionType": "example-value",
      "id": "example-value",
      "multiplicity": "example-value",
      "name": "example-value",
      "parentId": "example-value",
      "properties": [
        {
          "id": "example-value",
          "name": "example-value",
          "type": "example-value"
        }
      ],
      "sourceRef": "example-value",
      "structureRef": "example-value",
      "targetRefs": [
        "example-value"
      ]
    }
  ],
  "diagram": {
    "edges": [
      {
        "elementRef": "example-value",
        "id": "example-value",
        "sourceRef": "example-value",
        "standardEventVisible": true,
        "targetRef": "example-value",
        "waypoints": [
          {
            "x": 1.5,
            "y": 1.5
          }
        ]
      }
    ],
    "height": 1.5,
    "id": "example-value",
    "name": "example-value",
    "shapes": [
      {
        "collapsed": true,
        "elementRef": "example-value",
        "height": 1.5,
        "id": "example-value",
        "planningTableCollapsed": true,
        "width": 1.5,
        "x": 1.5,
        "y": 1.5
      }
    ],
    "width": 1.5
  },
  "fields": [
    {
      "description": "example-value",
      "id": "example-value",
      "label": "example-value",
      "maximum": 1.5,
      "minimum": 1.5,
      "options": [
        "example-value"
      ],
      "requiredAtStart": true,
      "sensitive": true,
      "type": "example-value"
    }
  ],
  "format": "example-value",
  "outcomes": [
    "example-value"
  ],
  "policies": {
    "allowReopen": true,
    "classification": "example-value",
    "completionMode": "example-value",
    "retentionDays": 1
  },
  "purpose": "example-value",
  "requirements": [
    {
      "appliesWhen": {
        "expressionLanguage": "example-value",
        "operator": "example-value",
        "source": "example-value",
        "value": "example-value"
      },
      "blocksCompletion": true,
      "description": "example-value",
      "due": {
        "amount": 1,
        "from": "example-value",
        "unit": "example-value"
      },
      "enforcement": "example-value",
      "fieldId": "example-value",
      "id": "example-value",
      "milestoneId": "example-value",
      "name": "example-value",
      "planItemId": "example-value",
      "responsibleRole": "example-value",
      "stageId": "example-value",
      "type": "example-value",
      "waivable": true,
      "waiverRole": "example-value"
    }
  ],
  "roles": [
    {
      "description": "example-value",
      "id": "example-value",
      "name": "example-value"
    }
  ],
  "schemaVersion": 1,
  "sentries": [
    {
      "id": "example-value",
      "ifPart": [
        {
          "expressionLanguage": "example-value",
          "operator": "example-value",
          "source": "example-value",
          "value": "example-value"
        }
      ],
      "name": "example-value",
      "onParts": [
        {
          "exitCriterionRef": "example-value",
          "id": "example-value",
          "sourceRef": "example-value",
          "sourceType": "example-value",
          "standardEvent": "example-value"
        }
      ]
    }
  ],
  "stages": [
    {
      "autoComplete": true,
      "control": {
        "manualActivation": {
          "condition": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "sentryRef": "example-value"
        },
        "repetition": {
          "condition": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "sentryRef": "example-value"
        },
        "required": {
          "condition": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "sentryRef": "example-value"
        }
      },
      "description": "example-value",
      "entryCriteria": [
        {
          "expressionLanguage": "example-value",
          "operator": "example-value",
          "source": "example-value",
          "value": "example-value"
        }
      ],
      "entrySentryRefs": [
        "example-value"
      ],
      "exitCriteria": [
        {
          "expressionLanguage": "example-value",
          "operator": "example-value",
          "source": "example-value",
          "value": "example-value"
        }
      ],
      "exitSentryRefs": [
        "example-value"
      ],
      "id": "example-value",
      "items": [
        {
          "authorizedRoles": [
            "example-value"
          ],
          "blocking": true,
          "caseTypeId": "example-value",
          "caseTypeVersion": 1,
          "children": [
            {}
          ],
          "control": {
            "manualActivation": {
              "condition": [
                {
                  "expressionLanguage": "example-value",
                  "operator": "example-value",
                  "source": "example-value",
                  "value": "example-value"
                }
              ],
              "sentryRef": "example-value"
            },
            "repetition": {
              "condition": [
                {
                  "expressionLanguage": "example-value",
                  "operator": "example-value",
                  "source": "example-value",
                  "value": "example-value"
                }
              ],
              "sentryRef": "example-value"
            },
            "required": {
              "condition": [
                {
                  "expressionLanguage": "example-value",
                  "operator": "example-value",
                  "source": "example-value",
                  "value": "example-value"
                }
              ],
              "sentryRef": "example-value"
            }
          },
          "correlationField": "example-value",
          "decision": {
            "hitPolicy": "example-value",
            "id": "example-value",
            "inputs": [
              {
                "id": "example-value",
                "label": "example-value"
              }
            ],
            "name": "example-value",
            "outputs": [
              {
                "id": "example-value",
                "label": "example-value"
              }
            ],
            "rules": [
              {
                "conditions": {},
                "id": "example-value",
                "outputs": {}
              }
            ]
          },
          "definitionRef": "example-value",
          "description": "example-value",
          "due": {
            "amount": 1,
            "from": "example-value",
            "unit": "example-value"
          },
          "entryCriteria": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "entrySentryRefs": [
            "example-value"
          ],
          "eventType": "example-value",
          "exitCriteria": [
            {
              "expressionLanguage": "example-value",
              "operator": "example-value",
              "source": "example-value",
              "value": "example-value"
            }
          ],
          "exitSentryRefs": [
            "example-value"
          ],
          "externalImportType": "example-value",
          "externalLocation": "example-value",
          "externalNamespace": "example-value",
          "externalPrefix": "example-value",
          "externalRef": "example-value",
          "id": "example-value",
          "implementationType": "example-value",
          "input": {},
          "inputMappings": [
            {
              "id": "example-value",
              "source": "example-value",
              "target": "example-value",
              "transformation": "example-value"
            }
          ],
          "manualActivation": true,
          "name": "example-value",
          "outputMappings": [
            {
              "id": "example-value",
              "source": "example-value",
              "target": "example-value",
              "transformation": "example-value"
            }
          ],
          "planningTable": {
            "applicabilityRules": [
              {
                "expressionLanguage": "example-value",
                "operator": "example-value",
                "source": "example-value",
                "value": "example-value"
              }
            ],
            "authorizedRoles": [
              "example-value"
            ],
            "id": "example-value",
            "itemRefs": [
              "example-value"
            ],
            "name": "example-value",
            "tables": [
              {}
            ]
          },
          "repeatable": true,
          "required": true,
          "roleId": "example-value",
          "timeoutMinutes": 1,
          "timerExpression": "example-value",
          "timerStart": {
            "exitCriterionRef": "example-value",
            "id": "example-value",
            "sourceRef": "example-value",
            "sourceType": "example-value",
            "standardEvent": "example-value"
          },
          "type": "example-value",
          "workflowId": "example-value",
          "workflowVersion": 1
        }
      ],
      "manualActivation": true,
      "name": "example-value",
      "parentId": "example-value",
      "planningTable": {
        "applicabilityRules": [
          {
            "expressionLanguage": "example-value",
            "operator": "example-value",
            "source": "example-value",
            "value": "example-value"
          }
        ],
        "authorizedRoles": [
          "example-value"
        ],
        "id": "example-value",
        "itemRefs": [
          "example-value"
        ],
        "name": "example-value",
        "tables": [
          {}
        ]
      },
      "repeatable": true,
      "required": true
    }
  ]
}
'@
Invoke-RestMethod -Method PUT `
  -Uri "$env:PUNAHA_URL/api/case-types/example-casetypeid/draft" `
  -Headers $headers `
  -ContentType "application/json" `
  -Body $body

deleteapiCaseTypesCaseTypeId, same domain
getapiCaseTypes, read or monitor
getapiCaseTypesCaseTypeId, read or monitor
getapiCaseTypesCaseTypeIdExportCmmn, read or monitor
getapiCaseTypesCaseTypeIdVersions, read or monitor
patchapiCaseTypesCaseTypeId, next action

Version history

Next Product release: Operation documented from the current registered Go route and handler contract.

Was this page helpful?

Your answer helps us improve the documentation.

Do not include personal information, customer information, passwords, or keys.

Draft case types

Operation details

Purpose

When to use it

When not to use it

Availability

Access

Address, query and header fields

Request body

Request fields

Responses

200 response fields

Behaviour and other effects

Reliability

Errors and corrections

Code examples

Version history

Was this page helpful?

Browse documentation

Choose a version

Search the guides

View the full screenshot

Operation details

Purpose

When to use it

When not to use it

Availability

Access

Address, query and header fields

Request body

Request fields

Responses

200 response fields

Behaviour and other effects

Reliability

Errors and corrections

Code examples

Related APIs

Version history

Was this page helpful?