REST API - read

REST API - read calls a single case data object.

Request

Format
GET <baseurl>/globaldata/ref/<caseReference>/read
Path parameters caseReference: The reference to the case object. You can obtain this by using findAllCases .

Response

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

Example

Request
GET <baseurl>/globaldata/ref/BDS-2-com.example.gddemo.Customer-1-1/read
Response
<?xml version="1.0" encoding="UTF-8"?>

<xml-fragment>

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

<casePayload>

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

<gddemo:CustomerElement

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

xmlns:gddemo="http://example.com/gddemo"

xsi:type="gddemo:Customer">

<customerID>Cust202</customerID>

<name>Joshy</name>

<addresses xsi:type="gddemo:Address">

<firstLine>4 Apple Walk</firstLine>

<secondLine>Swindon</secondLine>

</addresses>

<addresses xsi:type="gddemo:Address">

<firstLine>My Address</firstLine>

<secondLine>Oxford</secondLine>

</addresses>

</gddemo:CustomerElement>

</casePayload>

</xml-fragment>