POST method for Case stage

Edit online
Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
The POST method can perform case stage actions like completing current stage, holding the current stage, releasing the current stage, and starting previous stage.

URI

/CaseManager/CASEREST/v1/case/{CaseInstanceId}/stages

The URI for the POST method includes the following path element:

Table 1. Path element for the POST method
Name Type Description
{CaseInstanceId} String The ID that identifies the root folder of the case that is used to retrieve all stages.
The URI for the GET method includes the following parameter:
Table 2. Parameter for the POST method
Name Type Required? Description
TargetObjectStore String Yes This is a symbolic name of the object store that contains the case instances.
Operation String Yes Operations:
  • completeCurrentStage
  • placeCurrentStageOnHold
  • releaseCurrentOnHoldStage
  • restartPreviousStage

POST method request

Example:

This sample code requests to perform stage action for the case with the ID ending in EE55D8BCF2ED.

Request to get the list of case stages for the given case instance

/CaseManager/CASEREST/v1/case/9E45A997-0E42-406E-AAC4-EE55D8BCF2ED/stages?TargetObjectStore=MyTOS&Operation=releaseCurrentOnHoldStage

POST method response

{"removeStageOnHoldResult":true}