Pauses a case's SLA.
Namespace
goss.CaseManagement.v1.api.sla.pauseSLA
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String <businessKey> | The business key of the case |
| Optional Properties | Type | Description |
| caseControlVar | String | The name of a process variable. If this variable (with any value) can be found in the case workflow, the SLA will be paused. If it is not present the pause action will fail |
| note | String | The note that will be added to the case history |
| private | Boolean | Default: false. Set true to log a private note (only visible to case managers) |
| taskBusinessKey | String <businessKey> | Supply the business key of a case task to pause the SLA of that task |
| debug | Boolean | Default: false. Set true to return debug information ("notes") in the response message |
Example
See Case Management API for a full example call.
{
"caseBusinessKey": "0549-8592-0619-1521",
"note": "Paused on request",
"private": false
}
Responses
Success
This response has
{
"jsonrpc": "2.0",
"id": 20,
"result": {
"success": true,
"errors": [],
"notes": ["Timer paused: 2022-02-24T11:42:15.886Z", "Set counter: pauseCounter=1"]
}
}
Error
{
"jsonrpc": "2.0",
"id": 21,
"result": {
"success": false,
"errors": ["Cannot set workflow variable timerPausedTarget", "Cannot set workflow variable form_CASETARGETDATE", "Cannot set workflow variable form_CASEREMINDERDATE", "Cannot send target message to workflow for case"]
}
}
Share this page
