Boomi Platform API Reference (1.0.0) - RerunDocument

Toggle Pane

• RerunDocument
  • postCreates a RerunDocument object

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

RerunDocument

The Rerun Document object allows you to reprocess one or more documents from a previous run. You can rerun documents from a process’ Start shape or Trading Partner shape only.

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.

You can use the Rerun Document operation to reprocess either all documents for a given run by status, or individual documents (also known as Generic Connector Records) in a process run. A common usage pattern to rerun individual documents (Generic Connector Records) is to:

1. First, query for a particular Execution Record object record.
2. Next, retrieve the ExecutionConnector where startShape=true. The ExecutionConnector API response includes is StartShape=true or StartShape=false, and if true, you can rerun the record.
3. Then, retrieve the GenericConnectorRecords by status=ERROR (most common) for a particular ExecutionConnector record.
4. Call RerunDocument with the collection of GenericConnectorRecord IDs generated from the GenericConnectorRecords object in Step 3.
5. Finally, use the ExecutionRecord object with the requestId returned from the RerunDocument request, to get the result of the retry run.

Creates a RerunDocument object

Allows you to reprocess one or more documents from a previous run.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

required	object (AllDocuments) You must include either the AllDocuments field or the SelectedDocuments field in a request, but not both. Indicates that the Rerun Document operation reruns all documents in the original run. When using AllDocuments in a request, you must also specify a documentStatus value.
required	object (SelectedDocuments) You must include either the AllDocuments field or the SelectedDocuments field in a request, but not both. Indicates that the Rerun Document operation reruns only those documents you specify in the genericConnectorRecordId value.
originalExecutionId required	string The ID of the original process run. You can obtain the originalExecutionId from the user interface from the Process Reporting page, selecting the Actions menu for a specific process run, and selecting View Extended Information from the list of options.
recordUrl	string (Response-only field) The ID of the process run. The initial CREATE response returns this field and uses it in the subsequent call to find the corresponding run record.
requestId	string (Response-only field) The full endpoint URL used to make a second call to the Execution Record object. This URL is provided for your convenience in recordUrl field of the initial CREATE response.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (AllDocuments) You must include either the AllDocuments field or the SelectedDocuments field in a request, but not both. Indicates that the Rerun Document operation reruns all documents in the original run. When using AllDocuments in a request, you must also specify a documentStatus value.
required	object (SelectedDocuments) You must include either the AllDocuments field or the SelectedDocuments field in a request, but not both. Indicates that the Rerun Document operation reruns only those documents you specify in the genericConnectorRecordId value.
originalExecutionId required	string The ID of the original process run. You can obtain the originalExecutionId from the user interface from the Process Reporting page, selecting the Actions menu for a specific process run, and selecting View Extended Information from the list of options.
recordUrl	string (Response-only field) The ID of the process run. The initial CREATE response returns this field and uses it in the subsequent call to find the corresponding run record.
requestId	string (Response-only field) The full endpoint URL used to make a second call to the Execution Record object. This URL is provided for your convenience in recordUrl field of the initial CREATE response.

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}/RerunDocument

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "RerunDocument",
• "AllDocuments": {

  • "@type": "AllDocuments",
  • "documentStatus": "ANY"

  },
• "originalExecutionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "RerunDocument",
• "AllDocuments": {

  • "@type": "AllDocuments",
  • "documentStatus": "ANY"

  },
• "originalExecutionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"

}