Waiting for engine...
Skip to main content

Connector Document operation

You can programmatically download and view connector document data for a Generic Connector Record.

note

This operation is part of a series of process run-related API objects and operations for viewing and running documents using the Boomi Enterprise Platform API. You can use each object or operation conjunctively with one another to achieve a set of results pertaining to viewing or retrieving process run details. For a deeper dive into understanding the relationships and usability between each of these APIs, refer to the How to get integration process execution details with the Boomi Enterprise Platform API Community article.

The Connector Document operation allows you to download the raw, document data for a specific Generic Connector Record. The data is equivalent to viewing and downloading document data through the Process Reporting page.

The Connector Document operation is a two-step asynchronous process:

  1. The client first sends a CREATE request to the Boomi platform with a request body specifying a generic connector record object's ID.
  2. The platform returns ConnectorDocumentDownload object with a URL in the response.
  3. The client repeatedly polls the URL returned in step 2 to download the data. The platform will return an HTTP 202 status code until the data is ready.
  4. When ready the platform returns an HTTP 200 status code along with the document's content in text format as the body of the response. Note that once the document data has returned, it is no longer available for download. Submit a new CREATE request to download the same connector document again.
note

The Connector Document operation retrieves individual document data to assist with troubleshooting or testing. However, this object is not intended to perform bulk retrieval of all document data processed for archiving or analytics. Be advised that document data can be huge.

Structure​

<ConnectorDocument genericConnectorRecordId=”” url=””/>

FieldTypeDescription
genericConnectorRecordIdstring(Required in the CREATE request.) The ID of the individual document that you want to download. You can retrieve the genericConnectorRecordId by means of a QUERY operation on the Generic Connector Record object.
urlstring(Required) The endpoint URL to retrieve the connector document. This URL is returned in the initial CREATE response.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Not Supported Not Supported Supported  Not Supported Not SupportedNot Supported 

Using the CREATE operation​

  • You must provide a single Generic Connector Record ID in the request body.

  • This action submits the download request to the . The call returns a URL used to download the actual document data.

SOAP implementation​

To request the download of connector document data for a given process connector execution

  1. Send a SOAP request to https://api.boomi.com/api/soap/v1/<accountID>?wsdl

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

    Populate the request body with the genericConnectorRecordId, where the genericConnectorRecordId is the ID of the individual document that you want to download. Examples are shown below.

  • CREATE operation

    The following example query returns all HTTP-type connectors that exist on the account.

    Request:

    <soapenv:Body>
         <api:create>
           <object xsi:type="api:ConnectorDocument" genericConnectorRecordId="A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzLTQ0MmEtYjVhNS0zM2NiNDM0OTQ0ZjctMjAyMS4wMi4xNzpjb25uZWN0b3ItMTMzN2MyOWYtZDBhZC00Y2Q1LTgxYWEtMjkzNzA2NmJhZTcy" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
         </api:create>
      </soapenv:Body>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
           <bns:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
               <result xsi:type="bns:ConnectorDocumentDownload" url="https://api.platform.boomi.com/account/boomiaccount123/api/download/ConnectorDocument-a6bc21d6-94e6-4039-8f29-g4h1094i1802" message="Beginning download." statusCode="202"/>
           </bns:createResponse>
       </S:Body>
    </S:Envelope>

ConnectorDocumenDownload call

  • Send an HTTP GET using the URL returned in the CREATE request (Step 1). It needs to appear with the following format: https://api.boomi.com/api/rest/v1/account/<accountId>/api/download/<ConnectorDocumentID> where accountId is the ID of the authenticating account for the request) and ConnectorDocumentID is the identifier of the connector document you want to view
  • The document data will be returned as text within the body of the response along with an HTTP 200 status code.
  • If the data is not ready yet, an HTTP 202 status is returned. Clients should poll this URL until the data is successfully returned, or if an error is encountered (example below)

Example response

<Contact> 
 <Id>003A0000013uqbEIAQ</Id> 
 <AccountId>001A000000teuFnIAI</AccountId>
 <LastName>Freeholtz</LastName>
 <FirstName>Martin</FirstName>
 <MailingStreet /> 
 <MailingCity /> 
 <MailingState /> 
 <MailingPostalCode /> 
 <MobilePhone /> <Title /> 
 <Email>mfreeholtz@boomi.com</Email> 
</Contact>

Download request responses​

The download URL specified in a Log Download response, such as https://api.platform.boomi.com/account/boomiaccount123/api/download/ConnectorDocument-e6dc21a6-94f6-4039-8e29-a4b1094c1802, is valid for a single request.

These are the possible responses to an HTTP request to open a downloaded URL:

  • 200 (OK) - The download is complete. The downloaded log is in the response body.

    All subsequent requests to open the download URL returns 404 (Not Found).

  • 202 (Accepted) - The download is in progress.

    Before returning a final download response, you might receive multiple 202 responses.

  • 204 (No Content) - Log data is not available.

    All subsequent requests to open the download URL returns 404 (Not Found).

  • 404 (Not Found) - A 200, 204, or 504 response was returned from a previous request to open this URL.

  • 504 (Gateway Timeout) - The Runtime is unavailable. It might have timed out.

    All subsequent requests to open the download URL returns 404 (Not Found).

On this Page