Bulk GET operations

The bulk GET operation returns a maximum of 100 multiple API objects based on the supplied object IDs.

Most Boomi Enterprise Platform API objects that support the ordinary GET operation also support a bulk GET operation. With a bulk GET operation, you specify the object type and up to 100 object IDs. The operation returns all objects having the specified IDs.

The following example bulk GET requests are for the Process object.

Implementation

REST

XML

Send an HTTP POST to:

https://api.boomi.com/api/rest/v1/{accountId}/Process/bulk

where accountId is the ID of the authenticating account for the request.

Note that a specific process ID is replaced with the word bulk in the endpoint URL.

XML request

<api:BulkRequest xmlns:api="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" type="GET">
   <api:request xsi:type="api:BulkId" id="56789abc-def0-1234-5678-9abcdef01234"/>
   <api:request xsi:type="api:BulkId" id="not_a_real_process_id"/>
   <api:request xsi:type="api:BulkId" id="6789abcd-ef01-2345-6780-abcdef012345"/>
</api:BulkRequest>

XML response:

<bns:BulkResult xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <bns:response statusCode="200">
      <bns:Result xsi:type="bns:Process" id="56789abc-def0-1234-5678-9abcdef01234" name="Order Intake"/>
   </bns:response>
   <bns:response errorMessage="No such process" statusCode="400" id="not_a_real_process_ID"/>
   <bns:response statusCode="200">
      <bns:Result xsi:type="bns:Process" id="6789abcd-ef01-2345-6780-abcdef012345" name="Order Process"/>
   </bns:response>
</bns:BulkResult>

JSON

For a JSON request, send the request with the following HTTP header:

Content-Type: application/json

Request:

{
  "type" : "GET",
  "request" : [
    {
      "id" : "56789abc-def0-1234-5678-9abcdef01234"
    },
    {
      "id" : "not_a_real_process_id"
    },
    {
      "id" : "6789abcd-ef01-2345-6780-abcdef012345"
    }
  ]
}

For a JSON response, send the request with the following HTTP header:

Accept: application/json

Response:

{
  "@type" : "BulkResult",
  "response" : [ 
    {
      "@type" : "BulkResponse",
      "Result" : 
        {
          "@type" : "Process",
          "IntegrationPack" : [ ],
          "name" : "Order Intake",
          "id" : "56789abc-def0-1234-5678-9abcdef01234"
        },
      "statusCode" : 200
    },
    {
      "@type" : "BulkResponse",
      "id" : "not_a_real_process_id",
      "statusCode" : 400,
      "errorMessage" : "No such process"
    },
    {
      "@type" : "BulkResponse",
      "Result" : 
        {
          "@type" : "Process",
          "IntegrationPack" : [ ],
          "name" : "Order Process",
          "id" : "6789abcd-ef01-2345-6780-abcdef012345"
        },
      "statusCode" : 200
    }
  ]
}

SOAP

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">
 ATOMSPHERE_PASSWORD
          </wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:getBulk xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <api:objectType>Process</api:objectType>
         <api:bulkObject>
            <api:request xsi:type="api:BulkId" id="56789abc-def0-1234-5678-9abcdef01234"/>
            <api:request xsi:type="api:BulkId" id="not_a_real_process_id"/>
            <api:request xsi:type="api:BulkId" id="6789abcd-ef01-2345-6780-abcdef012345"/>
         </api:bulkObject>
      </api:getBulk>
   </soapenv:Body>
</soapenv:Envelope>

Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:getBulkResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:results>  
            <bns:response statusCode="200">
               <bns:Result xsi:type="bns:Process" id="56789abc-def0-1234-5678-9abcdef01234" name="Order Intake"/>
            </bns:response>
            <bns:response errorMessage="No such process" id="not_a_real_process_ID" statusCode="400"/>
            <bns:response statusCode="200">
               <bns:Result xsi:type="bns:Process" id="6789abcd-ef01-2345-6780-abcdef012345" name="Order Process"/>
            </bns:response>
         </bns:results>
     </bns:getBulkResponse>
   </S:Body>
</S:Envelope>