REST API - read

REST API - read reads multiple case data objects but is limited by maximum path length.

Request

Format
GET <baseurl>/globaldata/read?<caseReference>
Query parameters caseref=string: The reference to the case object. You can obtain this by using findAllCases .

Response

JSON Returns a JSON representation of the contents of a CaseDataArrayType element.
XML Returns the contents of a CaseDataArrayType element (from the BusinessDataServices schema)

Example

Request
GET <baseurl>/globaldata/read?caseref=BDS-2-com.example.gddemo.Car-4-0&caseref=BDS-2-com.example.gddemo.Car-6-0
Response
<?xml version="1.0" encoding="UTF-8"?>

<xml-fragment>

<caseData>

<caseReference>BDS-2-com.example.gddemo.Car-4-1</caseReference>

<casePayload>

<![CDATA[<?xml version="1.0" encoding="UTF-8"?>

<gddemo:CarElement

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:gddemo="http://example.com/gddemo" xsi:type="gddemo:Car">

<vehicleID>ID205</vehicleID>

<vehicleType>CAR</vehicleType>

<engine xsi:type="gddemo:Engine">

<model>1.6cc</model>

</engine>

<model>Vauxhall</model>

</gddemo:CarElement>

</casePayload>

</caseData>

<caseData>

<caseReference>BDS-2-com.example.gddemo.Car-6-1</caseReference>

<casePayload>

<![CDATA[<?xml version="1.0" encoding="UTF-8"?>

<gddemo:CarElement

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:gddemo="http://example.com/gddemo" xsi:type="gddemo:Car">

<vehicleID>ID1</vehicleID>

<vehicleType>CAR</vehicleType>

<engine xsi:type="gddemo:Engine">

<model>1.6cc</model>

</engine>

<model>Ford</model>

</gddemo:CarElement>

</casePayload>

</caseData>

</xml-fragment>