REST API - getCaseState - GET - single reference

The table summarizes the REST API - getCaseState - GET - single reference.

Request

Format GET <baseurl>/globaldata/ref/<caseReference>/casestate
Path parameters caseReference: The case reference of the case for which you want the case state returned. For example, BDS-1-com.example.statefunbdp.Order-11-0. You must only specify one. You can obtain the case reference by using findAllCases or getCaseReferencesForDataView.
Query parameters includeallowedvalues=Boolean (optional): Specify "true" to include all possible case state values in the response. Default = "false".

Response

JSON Returns a JSON representation of the content of a GetCaseStateResponse element.
XML Returns a GetCaseStateResponse element (from the BusinessDataServices schema).

Example

Request 
GET <baseurl>/globaldata/ref/BDS-1-com.example.statefunbdp.Order-11-0/casestate?includeallowedvalues=true
Response 
    {
        "result":
        {
            "caseReference": "BDS-1-com.example.statefunbdp.Order-11-0",
            "value":
            {
                "label": "Created",
                "name": "CREATED"
            },
            "allowedValue":
            [
                {
                    "label": "Created",
                    "name": "CREATED"
                },
                {
                    "label": "Picking",
                    "name": "PICKING"
                },
                {
                    "label": "Dispatched",
                    "name": "DISPATCHED"
                },
                {
                    "label": "Cancelled",
                    "name": "CANCELLED"
                }
            ]
        }
    }