Toggle menu

resumeSLA

Resumes a case's SLA.

Namespace

goss.CaseManagement.v1.api.sla.resumeSLA

Worker

serverlibrary

Parameters

Required PropertiesTypeDescription
caseBusinessKeyString <businessKey>The business key of the case
Optional PropertiesTypeDescription
caseControlVarStringThe 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
noteStringThe note that will be added to the case history
privateBooleanDefault: false. Set true to log a private note (only visible to case managers)
taskBusinessKeyString <businessKey>Supply the business key of a case task to resume the SLA of that task
taskClosedBooleanDefault: false. Set true if the task reference by the taskBusinessKey has already been closed
debugBooleanDefault: 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 01 September 2022

Share this page

Facebook icon Twitter icon email icon

Print

print icon