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 Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String <businessKey> | The business key of the case |
| Optional Properties | Type | Description |
| stageNotes | String | A note that will be added to the case history. Stage change notes are always private |
| stageValue | String | The stage to set. Must match one of the stages set in the configuration of this case type. However, if 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": "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 September 01, 2022
Share this page
