Case Management
CaseEscalationRequest
objectescalatedbooleanrequired
Whether the case should be escalated or de-escalated
Example:true
reasonstring
The reason for case escalation or de-escalation
Example:SLA Risk
sourcestring
The source for case escalation or de-escalation
Example:Call Center
Example
CaseCancelRequest
objectsourcestringrequired
Identifies the calling source/system
Example:Zinnia.BPMTransactions
cancellationReasonKeystringrequired
Key used to derive the configured caseResult and caseResultDetail from the reference store
Example:INVALID_CASE
Example
CaseCancelResponse
objectcaseIdstring
Example:CA00000234
statusstring
Case status after cancellation
Example:CANCELED
cancellationReasonKeystring
Example:INVALID_CASE
caseResultstring
Result derived from the cancellationReasonKey
Example:Invalid Case
caseResultDetailstring
Result detail derived from the cancellationReasonKey
Example:This case is identified as invalid
sourcestring
Example:Zinnia.BPMTransactions
cancelledAtstring(date-time)
Example:2026-06-29T10:15:30Z
correlationIdstring
Example:fab83a6e-af7f-4508-be31-2a343d90d2c8
messagestring
Present only for an idempotent replay of an already-cancelled case; in that case the cancellation detail fields (cancellationReasonKey, caseResult, caseResultDetail, source, cancelledAt, correlationId) are omitted.
Example:Case CA00000234 was already cancelled prior to this request
Example
CaseCancellationRequest
objectsourcestringrequired
Identifies the calling source/system
Example:Zinnia.SupportTool
cancellationReasonKeystringrequired
Key used to derive the configured caseResult and caseResultDetail from the reference store
Example:INVALID_CASE
carrierstringrequired
Must match the target case’s own carrier
Example:CarrierName_1
processstringrequired
Must match the target case’s own process
Example:Withdrawal
processSubTypestringrequired
Must match the target case’s own processSubType
Example:FullWithdrawal
jiraIdstringrequired
Jira/request reference for governance and traceability
Example:ZLCM-9014
approvedBystringrequired
Must be on the configured case-cancellation approver list
Example:jane.doe@zinnia.com
effectiveCancellationDatestring(date-time)required
ISO 8601 business-effective date; must fall strictly between the case’s creation date and the current time
Example:2026-06-29T10:15:30Z
supportingDocumentIdsarray[string]
EDS document IDs associated with the case
Example:DOC00001234
Example
CaseCancellationResponse
objectcancellationRequestIdstring
Generated id of the persisted case termination audit record
Example:CT0000114641
caseIdstring
Example:CA0000360227
cancellationStatusstring
Outcome recorded for this cancellation request
Example:CANCELLED
caseStatusstring
Outcome recorded for this cancellation request
Example:CANCELLED
messagestring
Human-readable note about the outcome
Example:Case CA0000360227 is already CANCELED and is not eligible for this request
Example