Toggle menu

updateCaseStage

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

Namespace

goss.CaseManagement.v1.api.stages.updateCaseStage

Worker

serverlibrary

Parameters

Required PropertiesTypeDescription
caseBusinessKeyString <businessKey>The business key of the case
Optional PropertiesTypeDescription
stageNotesStringA note that will be added to the case history. Stage change notes are always private
stageValueStringThe stage to set. Must match one of the stages set in the configuration of this case type. However, if the stageValue 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",
    "stageValue": "stage1",
    "stageNotes": "The stage has been set"
}

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": 194,
    "result": {
        "success": false,
        "errors": ["Cannot send stage update message to workflow for case"]
    }
}

Last modified on 01 September 2022

Share this page

Facebook icon Twitter icon email icon

Print

print icon