Boomi Platform API Reference (1.0.0) - ConnectorDocument

Toggle Pane

• ConnectorDocument
  • postCreates a ConnectorDocument object

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ConnectorDocument

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 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 Community article How to get integration process execution details with the AtomSphere API.

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.

Creates a ConnectorDocument object

The Connector Document operation allows you to download the raw, document data for a specific Generic Connector Record. This action submits the download request and the call returns a URL used to download the actual document data.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

genericConnectorRecordId

string 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.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

url	string The endpoint URL to retrieve the connector document. This URL is returned in the initial CREATE response.
message	string
statusCode	string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "genericConnectorRecordId": "A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzLTQ0MmEtYjVhNS0zM2NiNDM0OTQ0ZjctMjAyMS4wMi4xNzpjb25uZWN0b3ItMTMzN2MyOWYtZDBhZC00Y2Q1LTgxYWEtMjkzNzA2NmJhZTcy"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "ConnectorDocumentDownload",
• "url": "https://api.boomi.com/account/boomiaccount123/api/download/ConnectorDocument-a6bc21d6-94e6-4039-8f29-g4h1094i1802",
• "message": "Beginning download.",
• "statusCode": 202

}