API

Preview case types

Preview case types. This applies the validated business action to the selected tenant or platform resource.

POST/api/case-types/import/cmmn/preview
Preview

Preview case types. This applies the validated business action to the selected tenant or platform resource.

Operation ID postapiCaseTypesImportCmmnPreview

Operation details

Purpose

Preview case types. This applies the validated business action to the selected tenant or platform resource.

When to use it

Use this when the documented business action or resource creation is the intended next step.

When not to use it

Do not repeat the request blindly after an uncertain outcome. Read the resulting resource or background operation state first.

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 / create
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

FieldLocationPresenceTypeMeaningLimits and example
x-request-idheaderOptionalstringOptional caller supplied correlation identifier. Pūnaha returns the effective value in the response header.Minimum length: 1. Maximum length: 200. Example: example request 001

Request body

This operation does not define a request body.

Responses

StatusMeaning and correction boundaryBody
200The operation completed and the response contains the current operation specific representation.application/json, object
400The operation failed with HTTP 400. Inspect error.code and error.details, apply the documented correction, and retain x request id.application/json, APIError
401The operation failed with HTTP 401. Inspect error.code and error.details, apply the documented correction, and retain x request id.application/json, APIError
402The operation failed with HTTP 402. Inspect error.code and error.details, apply the documented correction, and retain x request id.application/json, APIError
403The operation failed with HTTP 403. Inspect error.code and error.details, apply the documented correction, and retain x request id.application/json, APIError
409The operation failed with HTTP 409. Inspect error.code and error.details, apply the documented correction, and retain x request id.application/json, APIError
423The operation failed with HTTP 423. Inspect error.code and error.details, apply the documented correction, and retain x request id.application/json, APIError
500The operation failed with HTTP 500. Inspect error.code and error.details, apply the documented correction, and retain x request id.application/json, APIError
503The 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 fields206 documented fields

200 response fields

FieldPresenceTypeMeaningEmpty and defaultLimits and exampleAccess, sensitivity and lifecycle
datarequiredobjectThe operation specific result.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: {}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.
data.definitionrequiredCaseworkDefinitionResponseThe definition 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 listedInherits 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.
data.definition.artifactsoptionallist of CaseworkCMMNArtifactResponseThe 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 valueInherits 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.
data.definition.artifacts[].directionoptionalstringThe 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 valueInherits 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.
data.definition.artifacts[].idrequiredstringThe 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 valueInherits 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.
data.definition.artifacts[].sourceRefoptionalstringThe 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 valueInherits 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.
data.definition.artifacts[].targetRefoptionalstringThe 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 valueInherits 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.
data.definition.artifacts[].textoptionalstringThe 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 valueInherits 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.
data.definition.artifacts[].textFormatoptionalstringThe 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 valueInherits 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.
data.definition.artifacts[].typerequiredstringThe 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 valueInherits 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.
data.definition.caseFileoptionallist of CaseworkCaseFileItemDefinitionResponseThe 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 valueInherits 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.
data.definition.caseFile[].definitionRefrequiredstringThe 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 valueInherits 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.
data.definition.caseFile[].definitionTypeoptionalstringThe 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 valueInherits 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.
data.definition.caseFile[].idrequiredstringThe 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 valueInherits 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.
data.definition.caseFile[].multiplicityrequiredstringThe 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 valueInherits 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.
data.definition.caseFile[].namerequiredstringThe 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 valueInherits 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.
data.definition.caseFile[].parentIdoptionalstringThe 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 valueInherits 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.
data.definition.caseFile[].propertiesoptionallist of CaseworkCaseFilePropertyResponseThe 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 valueInherits 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.
data.definition.caseFile[].properties[].idrequiredstringThe 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 valueInherits 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.
data.definition.caseFile[].properties[].namerequiredstringThe 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 valueInherits 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.
data.definition.caseFile[].properties[].typeoptionalstringThe 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 valueInherits 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.
data.definition.caseFile[].sourceRefoptionalstringThe 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 valueInherits 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.
data.definition.caseFile[].structureRefoptionalstringThe 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 valueInherits 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.
data.definition.caseFile[].targetRefsoptionallist of stringThe 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 valueInherits 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.
data.definition.diagramoptionalCaseworkCMMNDiagramResponseThe 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 listedInherits 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.
data.definition.diagram.edgesoptionallist of CaseworkCMMNEdgeResponseThe 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 valueInherits 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.
data.definition.diagram.edges[].elementRefoptionalstringThe 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 valueInherits 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.
data.definition.diagram.edges[].idrequiredstringThe 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 valueInherits 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.
data.definition.diagram.edges[].sourceRefoptionalstringThe 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 valueInherits 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.
data.definition.diagram.edges[].standardEventVisibleoptionalbooleanThe 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: YesInherits 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.
data.definition.diagram.edges[].targetRefoptionalstringThe 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 valueInherits 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.
data.definition.diagram.edges[].waypointsrequiredlist of CaseworkCMMNWaypointResponseThe 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 valueInherits 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.
data.definition.diagram.edges[].waypoints[].xrequirednumber in double formatThe 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.5Inherits 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.
data.definition.diagram.edges[].waypoints[].yrequirednumber in double formatThe 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.5Inherits 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.
data.definition.diagram.heightoptionalnumber in double formatThe 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.5Inherits 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.
data.definition.diagram.idoptionalstringThe 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 valueInherits 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.
data.definition.diagram.nameoptionalstringThe 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 valueInherits 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.
data.definition.diagram.shapesoptionallist of CaseworkCMMNShapeResponseThe 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 valueInherits 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.
data.definition.diagram.shapes[].collapsedoptionalbooleanThe 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: YesInherits 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.
data.definition.diagram.shapes[].elementRefrequiredstringThe 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 valueInherits 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.
data.definition.diagram.shapes[].heightrequirednumber in double formatThe 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.5Inherits 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.
data.definition.diagram.shapes[].idrequiredstringThe 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 valueInherits 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.
data.definition.diagram.shapes[].planningTableCollapsedoptionalbooleanThe 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: YesInherits 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.
data.definition.diagram.shapes[].widthrequirednumber in double formatThe 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.5Inherits 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.
data.definition.diagram.shapes[].xrequirednumber in double formatThe 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.5Inherits 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.
data.definition.diagram.shapes[].yrequirednumber in double formatThe 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.5Inherits 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.
data.definition.diagram.widthoptionalnumber in double formatThe 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.5Inherits 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.
data.definition.fieldsrequiredlist of CaseworkFieldResponseThe 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 valueInherits 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.
data.definition.fields[].descriptionoptionalstringThe 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 valueInherits 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.
data.definition.fields[].idrequiredstringThe 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 valueInherits 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.
data.definition.fields[].labelrequiredstringThe 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 valueInherits 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.
data.definition.fields[].maximumoptionalnumber in double format or nullThe 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.5Inherits 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.
data.definition.fields[].minimumoptionalnumber in double format or nullThe 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.5Inherits 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.
data.definition.fields[].optionsoptionallist of stringThe 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 valueInherits 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.
data.definition.fields[].requiredAtStartoptionalbooleanThe 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: YesInherits 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.
data.definition.fields[].sensitiveoptionalbooleanThe 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: YesInherits 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.
data.definition.fields[].typerequiredstringThe 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 valueInherits 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.
data.definition.formatrequiredstringThe 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 valueInherits 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.
data.definition.outcomesrequiredlist of stringThe 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 valueInherits 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.
data.definition.policiesrequiredCaseworkPoliciesResponseThe 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 listedInherits 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.
data.definition.policies.allowReopenrequiredbooleanThe 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: YesInherits 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.
data.definition.policies.classificationoptionalstringThe 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 valueInherits 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.
data.definition.policies.completionModerequiredstringThe 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 valueInherits 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.
data.definition.policies.retentionDaysoptionalinteger in int64 formatThe 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: 1Inherits 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.
data.definition.purposerequiredstringThe 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 valueInherits 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.
data.definition.requirementsrequiredlist of CaseworkRequirementResponseThe 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 valueInherits 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.
data.definition.requirements[].appliesWhenoptionalCaseworkCriterionResponse or nullThe 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 listedInherits 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.
data.definition.requirements[].blocksCompletionrequiredbooleanThe 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: YesInherits 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.
data.definition.requirements[].descriptionoptionalstringThe 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 valueInherits 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.
data.definition.requirements[].dueoptionalCaseworkDueRuleResponse or nullThe 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 listedInherits 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.
data.definition.requirements[].enforcementrequiredstringThe 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 valueInherits 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.
data.definition.requirements[].fieldIdoptionalstringThe 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 valueInherits 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.
data.definition.requirements[].idrequiredstringThe 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 valueInherits 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.
data.definition.requirements[].milestoneIdoptionalstringThe 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 valueInherits 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.
data.definition.requirements[].namerequiredstringThe 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 valueInherits 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.
data.definition.requirements[].planItemIdoptionalstringThe 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 valueInherits 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.
data.definition.requirements[].responsibleRoleoptionalstringThe 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 valueInherits 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.
data.definition.requirements[].stageIdoptionalstringThe 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 valueInherits 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.
data.definition.requirements[].typerequiredstringThe 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 valueInherits 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.
data.definition.requirements[].waivablerequiredbooleanThe 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: YesInherits 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.
data.definition.requirements[].waiverRoleoptionalstringThe 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 valueInherits 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.
data.definition.rolesrequiredlist of CaseworkRoleResponseThe 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 valueInherits 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.
data.definition.roles[].descriptionoptionalstringThe 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 valueInherits 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.
data.definition.roles[].idrequiredstringThe 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 valueInherits 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.
data.definition.roles[].namerequiredstringThe 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 valueInherits 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.
data.definition.schemaVersionrequiredinteger in int64 formatThe 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: 1Inherits 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.
data.definition.sentriesoptionallist of CaseworkSentryResponseThe 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 valueInherits 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.
data.definition.sentries[].idrequiredstringThe 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 valueInherits 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.
data.definition.sentries[].ifPartoptionallist of CaseworkCriterionResponseThe 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 valueInherits 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.
data.definition.sentries[].ifPart[].expressionLanguageoptionalstringThe 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 valueInherits 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.
data.definition.sentries[].ifPart[].operatorrequiredstringThe 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 valueInherits 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.
data.definition.sentries[].ifPart[].sourcerequiredstringThe 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 valueInherits 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.
data.definition.sentries[].ifPart[].valueoptionalJSON valueA 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 valueInherits 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.
data.definition.sentries[].nameoptionalstringThe 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 valueInherits 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.
data.definition.sentries[].onPartsoptionallist of CaseworkOnPartResponseThe 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 valueInherits 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.
data.definition.sentries[].onParts[].exitCriterionRefoptionalstringThe 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 valueInherits 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.
data.definition.sentries[].onParts[].idrequiredstringThe 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 valueInherits 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.
data.definition.sentries[].onParts[].sourceRefrequiredstringThe 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 valueInherits 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.
data.definition.sentries[].onParts[].sourceTyperequiredstringThe 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 valueInherits 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.
data.definition.sentries[].onParts[].standardEventrequiredstringThe 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 valueInherits 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.
data.definition.stagesrequiredlist of CaseworkStageResponseThe 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 valueInherits 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.
data.definition.stages[].autoCompleteoptionalbooleanThe 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: YesInherits 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.
data.definition.stages[].controloptionalCaseworkPlanItemControlResponseThe 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 listedInherits 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.
data.definition.stages[].control.manualActivationoptionalCaseworkControlRuleResponse or nullThe 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 listedInherits 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.
data.definition.stages[].control.repetitionoptionalCaseworkControlRuleResponse or nullThe 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 listedInherits 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.
data.definition.stages[].control.requiredoptionalCaseworkControlRuleResponse or nullThe 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 listedInherits 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.
data.definition.stages[].descriptionoptionalstringThe 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 valueInherits 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.
data.definition.stages[].entryCriteriaoptionallist of CaseworkCriterionResponseThe 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 valueInherits 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.
data.definition.stages[].entryCriteria[].expressionLanguageoptionalstringThe 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 valueInherits 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.
data.definition.stages[].entryCriteria[].operatorrequiredstringThe 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 valueInherits 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.
data.definition.stages[].entryCriteria[].sourcerequiredstringThe 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 valueInherits 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.
data.definition.stages[].entryCriteria[].valueoptionalJSON valueA 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 valueInherits 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.
data.definition.stages[].entrySentryRefsoptionallist of stringThe 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 valueInherits 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.
data.definition.stages[].exitCriteriaoptionallist of CaseworkCriterionResponseThe 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 valueInherits 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.
data.definition.stages[].exitCriteria[].expressionLanguageoptionalstringThe 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 valueInherits 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.
data.definition.stages[].exitCriteria[].operatorrequiredstringThe 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 valueInherits 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.
data.definition.stages[].exitCriteria[].sourcerequiredstringThe 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 valueInherits 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.
data.definition.stages[].exitCriteria[].valueoptionalJSON valueA 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 valueInherits 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.
data.definition.stages[].exitSentryRefsoptionallist of stringThe 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 valueInherits 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.
data.definition.stages[].idrequiredstringThe 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 valueInherits 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.
data.definition.stages[].itemsrequiredlist of CaseworkPlanItemResponseThe 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 valueInherits 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.
data.definition.stages[].items[].authorizedRolesoptionallist of stringThe 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 valueInherits 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.
data.definition.stages[].items[].blockingoptionalboolean or nullThe 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: YesInherits 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.
data.definition.stages[].items[].caseTypeIdoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].caseTypeVersionoptionalinteger in int64 formatThe 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: 1Inherits 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.
data.definition.stages[].items[].childrenoptionallist of CaseworkPlanItemResponseThe 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 valueInherits 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.
data.definition.stages[].items[].controloptionalCaseworkPlanItemControlResponseThe 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 listedInherits 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.
data.definition.stages[].items[].control.manualActivationoptionalCaseworkControlRuleResponse or nullThe 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 listedInherits 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.
data.definition.stages[].items[].control.repetitionoptionalCaseworkControlRuleResponse or nullThe 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 listedInherits 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.
data.definition.stages[].items[].control.requiredoptionalCaseworkControlRuleResponse or nullThe 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 listedInherits 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.
data.definition.stages[].items[].correlationFieldoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].decisionoptionalCaseworkDecisionTableResponse or nullThe 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 listedInherits 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.
data.definition.stages[].items[].definitionRefoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].descriptionoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].dueoptionalCaseworkDueRuleResponse or nullThe 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 listedInherits 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.
data.definition.stages[].items[].entryCriteriaoptionallist of CaseworkCriterionResponseThe 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 valueInherits 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.
data.definition.stages[].items[].entryCriteria[].expressionLanguageoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].entryCriteria[].operatorrequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].entryCriteria[].sourcerequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].entryCriteria[].valueoptionalJSON valueA 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 valueInherits 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.
data.definition.stages[].items[].entrySentryRefsoptionallist of stringThe 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 valueInherits 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.
data.definition.stages[].items[].eventTypeoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].exitCriteriaoptionallist of CaseworkCriterionResponseThe 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 valueInherits 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.
data.definition.stages[].items[].exitCriteria[].expressionLanguageoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].exitCriteria[].operatorrequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].exitCriteria[].sourcerequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].exitCriteria[].valueoptionalJSON valueA 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 valueInherits 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.
data.definition.stages[].items[].exitSentryRefsoptionallist of stringThe 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 valueInherits 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.
data.definition.stages[].items[].externalImportTypeoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].externalLocationoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].externalNamespaceoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].externalPrefixoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].externalRefoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].idrequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].implementationTypeoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].inputoptionalobjectKeys 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.
data.definition.stages[].items[].inputMappingsoptionallist of CaseworkParameterMappingResponseThe 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 valueInherits 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.
data.definition.stages[].items[].inputMappings[].idrequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].inputMappings[].sourcerequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].inputMappings[].targetrequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].inputMappings[].transformationoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].manualActivationoptionalbooleanThe 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: YesInherits 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.
data.definition.stages[].items[].namerequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].outputMappingsoptionallist of CaseworkParameterMappingResponseThe 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 valueInherits 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.
data.definition.stages[].items[].outputMappings[].idrequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].outputMappings[].sourcerequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].outputMappings[].targetrequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].outputMappings[].transformationoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].planningTableoptionalCaseworkPlanningTableResponse or nullThe 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 listedInherits 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.
data.definition.stages[].items[].repeatableoptionalbooleanThe 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: YesInherits 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.
data.definition.stages[].items[].requiredrequiredbooleanThe 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: YesInherits 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.
data.definition.stages[].items[].roleIdoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].timeoutMinutesoptionalinteger in int64 formatThe 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: 1Inherits 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.
data.definition.stages[].items[].timerExpressionoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].timerStartoptionalCaseworkOnPartResponse or nullThe 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 listedInherits 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.
data.definition.stages[].items[].typerequiredstringThe 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 valueInherits 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.
data.definition.stages[].items[].workflowIdoptionalstringThe 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 valueInherits 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.
data.definition.stages[].items[].workflowVersionoptionalinteger in int64 formatThe 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: 1Inherits 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.
data.definition.stages[].manualActivationoptionalbooleanThe 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: YesInherits 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.
data.definition.stages[].namerequiredstringThe 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 valueInherits 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.
data.definition.stages[].parentIdoptionalstringThe 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 valueInherits 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.
data.definition.stages[].planningTableoptionalCaseworkPlanningTableResponse or nullThe 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 listedInherits 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.
data.definition.stages[].repeatableoptionalbooleanThe 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: YesInherits 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.
data.definition.stages[].requiredrequiredbooleanThe 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: YesInherits 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.
data.reportrequiredCaseworkCMMNReportResponseThe report 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 listedInherits 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.
data.report.exactRoundTriprequiredbooleanThe exact round trip 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: YesInherits 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.
data.report.importedrequiredlist of stringThe imported 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 valueInherits 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.
data.report.schemaValidrequiredbooleanThe schema valid 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: YesInherits 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.
data.report.semanticSha256requiredstringThe semantic sha256 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 valueInherits 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.
data.report.sourcePreservedrequiredbooleanThe source preserved 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: YesInherits 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.
data.report.sourceSha256requiredstringThe source sha256 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 valueInherits 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.
data.report.standardrequiredstringThe standard 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 valueInherits 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.
data.report.validationrequiredCaseworkCMMNValidationReportResponseThe validation 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 listedInherits 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.
data.report.validation.diagnosticsoptionallist of CaseworkCMMNValidationDiagnosticResponseThe diagnostics 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 valueInherits 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.
data.report.validation.diagnostics[].coderequiredstringA stable machine readable code for the represented condition.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 valueInherits 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.
data.report.validation.diagnostics[].columnoptionalinteger in int64 formatThe column 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: 1Inherits 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.
data.report.validation.diagnostics[].lineoptionalinteger in int64 formatThe line 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: 1Inherits 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.
data.report.validation.diagnostics[].messagerequiredstringA human readable explanation intended to help understand the result.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 valueInherits 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.
data.report.validation.diagnostics[].pathoptionalstringThe path 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 valueInherits 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.
data.report.validation.namespaceoptionalstringThe 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 valueInherits 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.
data.report.validation.schemaValidrequiredbooleanThe schema valid 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: YesInherits 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.
data.report.validation.standardrequiredstringThe standard 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 valueInherits 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.
data.report.validation.statusrequiredstringThe current lifecycle or processing state.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 valueInherits 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.
data.report.validation.versionrequiredstringThe 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: example valueInherits 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.
data.report.versionrequiredstringThe 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: example valueInherits 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.
data.report.warningsrequiredlist of stringThe warnings 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 valueInherits 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": {
    "definition": {
      "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
        }
      ]
    },
    "report": {
      "exactRoundTrip": true,
      "imported": [
        "example-value"
      ],
      "schemaValid": true,
      "semanticSha256": "example-value",
      "sourcePreserved": true,
      "sourceSha256": "example-value",
      "standard": "example-value",
      "validation": {
        "diagnostics": [
          {
            "code": "example-value",
            "column": 1,
            "line": 1,
            "message": "example-value",
            "path": "example-value"
          }
        ],
        "namespace": "example-value",
        "schemaValid": true,
        "standard": "example-value",
        "status": "example-value",
        "version": "example-value"
      },
      "version": "example-value",
      "warnings": [
        "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
The mutation is subject to the Product audit policy. The exact event name is operation owned and must be reviewed before publication.
Background work
The operation may create, observe, or advance background work. Use the related read, event, or status operation before retrying after an uncertain outcome.
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
No
Retry
Do not retry automatically after a timeout or lost response. Read current state first.
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

StatusCodeCauseCorrectionRetryablePartial work
400INVALID_REQUEST_BODYThe 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 retryNo requested mutation is expected before this failure boundary.
401AUTHENTICATION_REQUIREDA valid authenticated session or supported token is required.Authenticate again using a supported mechanism and confirm that the credential is current.No unchanged retryNo requested mutation is expected before this failure boundary.
402FEATURE_NOT_LICENSEDThe 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 retryNo requested mutation is expected before this failure boundary.
403PERMISSION_REQUIREDThe 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 retryNo requested mutation is expected before this failure boundary.
409STATE_CONFLICTCurrent 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 retryThe caller must read current resource or background operation state before retrying because work may have started before the failure became observable.
423LICENCE_REMEDIATION_REQUIREDThe installation is restricted and permits only licence remediation actions.Complete the indicated licence or membership remediation before retrying Product work.No unchanged retryThe caller must read current resource or background operation state before retrying because work may have started before the failure became observable.
500INTERNAL_ERRORPū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 retryThe caller must read current resource or background operation state before retrying because work may have started before the failure became observable.
503DEPENDENCY_UNAVAILABLEA 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 safeguardsThe 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 POST "$PUNAHA_URL/api/case-types/import/cmmn/preview" \
  --header "Authorization: Bearer $PUNAHA_TOKEN" \
  --header "x-request-id: example-request-001"

Version history

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

Pūnaha Docs

Search the guides

Enter at least two characters.

    Product screen

    View the full screenshot