REST API - getCaseSummary - GET

The table summarizes the REST API - getCaseSummary - GET.

Request

Format GET <baseurl>/globaldata/summary
Query parameters caseref=String: Can be obtained using getCaseReferencesForDataView.

includeLabelAndType=Boolean (optional): Specify "true" to include attribute labels and types in the response. 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 
GET <baseurl>/globaldata/summary?caseref=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"
      }
    ]
  }
}