REST API - getCaseSummary - POST

The table summarizes the REST API - getCaseSummary - POST.

Request

Format POST <baseurl>/globaldata/summaryx
Body The case reference is embedded in the request body.

Can also optionally specify that attribute labels and types be returned by including includeLabelAndType in the request body and setting it to "true". Default = "false".

Response

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

Example

Request 
POST <baseurl>/globaldata/summaryx
Body 
{ 
 "GetCaseSummaryRequest":
        {
             "caseReference":["BDS-1-com.example.hastings.Order-5-0"],
             "@includeLabelAndType":"true"
        }
}
Response 
{
  "caseReferenceDetails": {
    "caseReference": "BDS-1-com.example.hastings.Order-5-0",
    "details": [
      {
        "-isCaseIdentifier": "true",
        "name": "orderNum",
        "label": "OrderNum",
        "value": "66533",
        "type": "ATTR_INTEGER"
      },
      {
        "name": "acctNum",
        "label": "AcctNum",
        "value": "786784",
        "type": "ATTR_TEXT"
      },
      {
        "name": "orderDate",
        "label": "OrderDate",
        "value": "2015-01-15Z",
        "type": "ATTR_DATE"
      }
    ]
  }
}