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.
  • casemetadata=boolean (optional, default=false): Indicates whether to return case metadata.

Response

JSON Note - ActiveMatrix BPM does not support case data being returned in JSON format for this operation. If an Accept header of application/json is specified, case data is not returned in the response. Therefore, for this operation, you should specify the response be in XML format (application/xml).
XML Returns the contents of a CaseDataArrayType element (from the BusinessDataServices schema).

Example

Request 
GET <baseurl>/globaldata/read?caseref=BDS-1-com.example.hastings.Order-3-0&caseref=BDS-1-com.example.hastings.Order-7-0
Response 
<?xml version="1.0" encoding="UTF-8"?>
    <xml-fragment>
      <caseData>
        <caseReference>BDS-1-com.example.hastings.Order-3-0</caseReference>
        <casePayload>
          <![CDATA[<?xml version="1.0" encoding="UTF-8"?>
          <hastings:OrderElement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:hastings="http://example.com/hastings" xsi:type="hastings:Order">
              <orderNum>76576533</orderNum>
              <acctNum>876-900</acctNum>
              <orderDate>2016-06-27</orderDate>
              <lineItems xsi:type="hastings:LineItem">
                <partNum>625528</partNum>
                <quantity>50</quantity>
                <price>24.99</price>
                <vendor xsi:type="hastings:Vendor">
                  <name>Morgan Interprises</name>
                  <address xsi:type="hastings:Address">
                    <street>1200 24th Ave.</street>
                    <city>Spokane</city>
                    <state>WA</state>
                    <zip>98760</zip>
                  </address>
                </vendor>
              </lineItems>
          </hastings:OrderElement>
          ]]>
        </casePayload>
      </caseData>
      <caseData>
        <caseReference>BDS-1-com.example.hastings.Order-7-0</caseReference>
        <casePayload>
          <![CDATA[<?xml version="1.0" encoding="UTF-8"?>
          <hastings:OrderElement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:hastings="http://example.com/hastings" xsi:type="hastings:Order">
              <orderNum>65543</orderNum>
              <acctNum>876864-00</acctNum>
              <orderDate>2016-06-27</orderDate>
              <lineItems xsi:type="hastings:LineItem">
                <partNum>876223</partNum>
                <quantity>22</quantity>
                <price>120.0</price>
                <vendor xsi:type="hastings:Vendor">
                  <name>Vic's Glass</name>
                  <address xsi:type="hastings:Address">
                    <street>899 Main St.</street>
                    <city>Spokane</city>
                    <state>WA</state>
                    <zip>99887</zip>
                  </address>
                </vendor>
              </lineItems>
          </hastings:OrderElement>
          ]]>
        </casePayload>
      </caseData>
    </xml-fragment>