Retrieve Case Data

get

/cases/{id}/casedata

Retrieves case data.

• Request
• Response
• Examples

Request

There are no request parameters for this operation.

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

Body

Root Schema : /paths/~1cases~1{id}~1casedata/get/responses/200/schema

Example application/json

{
    "type":"caseDataList",
    "levels":0,
    "links":[
        {
            "rel":"back",
            "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c"
        },
        {
            "rel":"self",
            "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/casedata"
        }
    ],
    "casedata":{
        "casedata":[
            {
                "dataName":"customerStatus",
                "dataStr":"<customerStatus> <status>RUBY</status></customerStatus>",
                "external":false,
                "updatedDate":"2015-06-05 19:43:31"
            },
            {
                "dataName":"driver",
                "dataStr":"<eurent:driver xmlns:eurent=\"http://xmlns.example.com/samples/casemgmt/EURent\"><eurent:firstName>Jim</eurent:firstName><eurent:lastName>Mitch</eurent:lastName><eurent:licenseNumber>DL345554</eurent:licenseNumber><eurent:age>30</eurent:age></eurent:driver>",
                "external":false,
                "updatedDate":"2015-06-05 17:42:50"
            },
            {
                "dataName":"reservation",
                "dataStr":"<eurent:reservation xmlns:eurent=\"http://xmlns.example.com/samples/casemgmt/EURent\"><eurent:id/><eurent:carType>COMPACT</eurent:carType><eurent:pickup>2012-03-11</eurent:pickup><eurent:dropoff>2012-03-15</eurent:dropoff><eurent:actualDropOff>2012-03-15</eurent:actualDropOff><eurent:totalCost/></eurent:reservation>",
                "external":false,
                "updatedDate":"2015-06-05 17:42:50"
            }
        ]
    }
}

Examples

The following example shows a response body when retrieving case data.

   { 
                      "type": "caseDataList",
                      "levels": 0,
                      "links": [{
                      "rel": "back",
                      "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c"
                       },
                       {
                      "rel": "self",
                      "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/casedata"
                        }],
                       "casedata": {
                       "casedata": [{
                       "dataName": "customerStatus",
                       "dataStr": "<customerStatus> <status>RUBY</status></customerStatus>",
                       "external": false,
                       "updatedDate": "2015-06-05 19:43:31"
                          },
                               {
                       "dataName": "driver",
                       "dataStr": "<eurent:driver xmlns:eurent=\"http://xmlns.example.com/samples/casemgmt/EURent\"><eurent:firstName>Jim</eurent:firstName><eurent:lastName>Mitch</eurent:lastName><eurent:licenseNumber>DL345554</eurent:licenseNumber><eurent:age>30</eurent:age></eurent:driver>",
                       "external": false,
                       "updatedDate": "2015-06-05 17:42:50"
                          },
                           {
                        "dataName": "reservation",
                        "dataStr": "<eurent:reservation xmlns:eurent=\"http://xmlns.example.com/samples/casemgmt/EURent\"><eurent:id/><eurent:carType>COMPACT</eurent:carType><eurent:pickup>2012-03-11</eurent:pickup><eurent:dropoff>2012-03-15</eurent:dropoff><eurent:actualDropOff>2012-03-15</eurent:actualDropOff><eurent:totalCost/></eurent:reservation>",
                        "external": false,
                        "updatedDate": "2015-06-05 17:42:50"
                          }]
                            }
                        }

For more information about cURL, see Use cURL