Resumes a case's SLA.
Namespace
goss.CaseManagement.v1.api.sla.resumeSLA
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 resumed. If it is not present the resumeaction 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 resume the SLA of that task |
taskClosed | Boolean | Default: false. Set true if the task reference by the |
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": "Resumed on request",
"private": false
}
Responses
Success
{
"jsonrpc": "2.0",
"id": 20,
"result": {
"success": true,
"errors": []
}
}
Error
{
"jsonrpc": "2.0",
"id": 23,
"result": {
"success": false,
"errors": ["Case is not paused"]
}
}
Last modified on September 01, 2022