GET method for the list of case types resource

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

The GET method for the list of case types resource returns information about each case type that is defined for a specified solution.

URI

/CASEREST/v1/solution/{solution name}/casetypes

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

Table 1. Path element for the GET method
Name	Type	Description
`{solution name}`	String	The name of the solution for which the list of case types 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.

Request content

The request for this method contains no JSON content.

Response content

For each case type, the method returns the following information:

DisplayName: The name that is displayed for the case type.
Description: The description of the case type.
HasInstanceCreationRights: A Boolean value that is set to true if the case worker has permission to create a case of this case type and a subfolder of the case type folder.
These permissions are set when you configure security by using IBM® Administration Console for Content Platform Engine or by using IBM Business Automation Workflow Case administration client. Permission to create a case is set by selecting the Create instance right for the specific case type. Permission to create a subfolder is set by selecting the Create subfolder right for the case type folder.
HasAnnotationRights: A Boolean value that is set to true if the case worker has permission to add a case of this case type to a folder. A case worker must have this permission to split a case of this case type.
These permissions are set when you configure security by using IBM Administration Console for Content Platform Engine or by using IBM Business Automation Workflow administration client. Permission to create a case by splitting an existing case is set by selecting the File in folder/Annotate right for the case type folder.

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

Table 3. Response codes for the GET method
Code	Description
200 OK	The method completed successfully. The requested list of case types was returned.
400 Bad Request	The required TargetObjectStore parameter was not specified or a parameter value was invalid.
404 Not Found	Either the solution specified in the request URI was not found or no case types were found for the specified solution. For more information, see the userMessage element in the JSON response.
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 a list of the case types that are defined for the deployed Auto Claims solution:

GET http://example.com:9080/CaseManager/CASEREST/v1/solution/Auto+Claims
/casetypes?TargetObjectStore=MyTOS HTTP/1.1
Host: www.example.net

Example: GET method

This sample code shows the list of case types that is returned for the deployed Auto Claims solution:

HTTP/1.1 200 OK
Content-Type: application/json;charset-UTF-8
{
  "CaseTypes":
  [
    {
      "CaseType": "AUTO_CollisionClaim",
      "DisplayName": "Collision Claim",
      "Description": "process a collision claim"
      "HasInstanceCreationRights": true,
      "HasAnnotationRights": true
    },
    {
      "CaseType": "AUTO_LiabilityClaim",
      "DisplayName" : "Liability Claim",
      "Description": "process a liability claim"
      "HasInstanceCreationRights": true,
      "HasAnnotationRights": true
    },
    ...
  ]
}