Clears a case's SLA. The SLA will be removed as if one hadn't been set. See Details, Status, Summary and Target SLAs for a description of SLA behaviour.
Namespace
goss.CaseManagement.v1.api.sla.clearSLA
Worker
serverlibrary
Parameters
Required Properties | Type | Description |
---|---|---|
caseBusinessKey | String <businessKey> | The business key of the case |
Optional Properties | Type | Description |
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) |
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": "SLA no longer needed",
"private": false
}
Responses
Success
This response has
{
"jsonrpc": "2.0",
"id": 16,
"result": {
"success": true,
"errors": [],
"notes": ["Target: ", "Target update message sent to workflow", "Reminder: ", "Reminder update message sent to workflow", "Timer clear requested"]
}
}
Error
{
"jsonrpc": "2.0",
"id": 19,
"result": {
"success": false,
"errors": ["Cannot set workflow variable form_CASETARGETDATE", "Cannot set workflow variable form_CASEREMINDERDATE"]
}
}