REST API - getCaseState - GET - multiple references

The table summarizes the REST API - getCaseState - GET - multiple references.

Request

Format GET <baseurl>/globaldata/casestate
Query parameters
  • caseref=String: Specify one or more. Can be obtained using findAllCases or getCaseReferencesForDataView.
  • 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/casestate?caseref=BDS-1-com.example.statefunbdp.Order-11-0&caseref=BDS-1-com.example.statefunbdp.Order-12-0&includeallowedvalues=true
Response 
    {
        "xml-fragment":
        {
            "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"
                        }
                    ]
                },
                {
                    "caseReference": "BDS-1-com.example.statefunbdp.Order-12-0",
                    "value":
                    {
                        "label": "Picking",
                        "name": "PICKING"
                    },
                    "allowedValue":
                    [
                        {
                            "label": "Created",
                            "name": "CREATED"
                        },
                        {
                            "label": "Picking",
                            "name": "PICKING"
                        },
                        {
                            "label": "Dispatched",
                            "name": "DISPATCHED"
                        },
                        {
                            "label": "Cancelled",
                            "name": "CANCELLED"
                        }
                    ]
                }
            ]
        }
    }