GET method for the status of particular case resource

Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15

The GET method for the status of particular case resource returns a value that indicates the status of a specified case. The status indicates the state of the case as complete, failed, initializing, new, or working.

URI

/CASEREST/v1/case/{case folder id}/status

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

Table 1. Path element for the POST method
Name	Type	Description
`{case folder id}`	String	The GUID that identifies the root folder of the case for which status is to be returned.

The URI for the GET method includes the following parameter:

Table 2. Parameter for the GET method
Name	Type	Required?	Description
TargetObjectStore	String	Yes	The symbolic name of the object store that contains the case type. A symbolic name is called a unique identifier in IBM® Business Automation Workflow.

Request content

The request for this method contains no JSON content.

Response content

The GET method returns the case identifier, the date that the case was created, and the date that the case was last modified. In addition, the method returns one of the following values that indicates the status of the case. You can query this value to determine whether a case was successfully created.

Table 3. Case status values
Value	Description
Complete	All activities that are associated with the case are completed.
Failed	The case was not created. The response might still include a case ID and a case creation date if the case folder was created.
Initializing	The case is being created, but is not yet ready to be worked on.
New	The process of creating the case started.
Working	The case was created and is ready to be worked on.

The GET method also returns one of the following response codes:

Table 4. Response codes for the GET method
Code	Description
200 OK	The method completed successfully. The response that is returned by the GET method includes the status of the specified case.
400 Bad Request	The required TargetObjectStore parameter was missing, or the parameter value was invalid.
404 Not Found	The case specified in the request was not found.
500 Internal Server Error	A server error occurred. For information about the error, see the userMessage element in the JSON response.

Example: GET method request

This sample code requests the status of the case in a specified case folder:

#Request 
GET /CASEREST/v1/case/9E45A997-0E42-406E-AAC4-EE55D8BCF2ED/status
?TargetObjectStore=MyExampleObjectStore
 HTTP/1.1
Host: www.CaseMgmtExample.net

Example: GET method

This sample code shows the response to the request, with the status of the case:

#Response
  HTTP/1.1 200 OK
  Content-Type: application/json;charset-UTF-8
{
    "Status": "Working",
    "CaseIdentifier":"MY_Case_000000100105",
    "DateCreated":" 2010-07-16T21:50:36Z",
    "DateLastModified":"2010-07-16T21:50:36Z"
}