Toggle menu

updateCaseStatus

Updates a case's status. The status supplied must match one of the statuses in the case type's configuration.

Namespace

goss.CaseManagement.v1.api.updateCaseStatus

Worker

serverlibrary

Parameters

Required PropertiesTypeDescription
caseBusinessKeyString <businessKey>The business key of the case
Optional PropertiesTypeDescription
statusNotesStringA note that will be added to the case history
statusValueStringThe status to set. Must match one of the statuses set in the configuration of this case type. However, if the statusValue doesn't exist, no errors are returned, the request just doesn't do anything
debugBooleanDefault: false. Set true to return debug information ("notes") in the response message

Example

See Case Management API for a full example call.

{
    "caseBusinessKey": "8895-4890-0231-7127",
    "statusValue": "Pending"
}

Responses

Success

{
    "jsonrpc": "2.0",
    "id": 191,
    "result": {
        "success": true,
        "errors": []
    }
}

Error

In this case the business key didn't exist.

{
    "jsonrpc": "2.0",
    "id": 206,
    "result": {
        "success": false,
        "errors": ["CM error: Couldn't find any active executions."]
    }
}

Last modified on 01 September 2022

Share this page

Facebook icon Twitter icon email icon

Print

print icon