Rerun Document operation

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 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, see the Community article How to get integration process execution details with the Boomi Enterprise Platform 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.

Structure

<RerunDocument originalExecutionId="" requestId="" recordUrl="">
    <AllDocuments documentStatus=""/>
   <!-- OR -->
    <SelectedDocuments>
        <Document genericConnectorRecordId=""/>
        </SelectedDocuments>
</RerunDocument>

Field	Type	Description
Filter	Filter	Filter
originalExecutionId	string	(Required) 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 ( gear icon) for a specific process run, and selecting View Extended Information from the list of options.
AllDocuments	string	Note: You must include either the AllDocuments field or the SelectedDocuments field in a request, but not both. (Required) 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. Accepted values are ANY, SUCCESS, or ERROR. - A value of ANY reruns all documents in the specified process run (in other words, the originalExecutionID). - A value of SUCCESS returns successfully run documents in the process run. - A value of ERROR returns documents that unsuccessfully ran in the process run.
SelectedDocuments	string	Note: You must include either the AllDocuments field or the SelectedDocuments field in a request, but not both. (Required) Indicates that the Rerun Document operation reruns only those documents you specify in the genericConnectorRecordId value. When using SelectedDocuments in a request, you must also specify genericConnectorRecordId, which specifies the individual documents that you want to rerun.
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.
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.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not Supported	Not Supported	Supported	Not Supported	Not Supported	Not Supported

Using the CREATE operation

• Requires either AllDocuments or SelectedDocuments in the request, but not both.

• When using AllDocuments in a request, you must also specify a documentStatus value. In process runs, the values are:

  • ANY that reruns all documents, in other words, originalExecutionID
  • SUCCESS returns successfully run documents only
  • ERROR returns unsuccessfully run documents only

• If using SelectedDocuments in a request, you must also use the genericConnectorRecordId, which specifies the individual documents that you want to rerun.

SOAP implementation

Send a SOAP request to:

https://api.boomi.com/api/soap/v1/<accountId>/RerunDocument

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

• CREATE operation

  Request:

  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
     <soapenv:Header/>
     <soapenv:Body>
        <api:create>
           <!--Optional:-->
           <object xsi:type="api:RerunDocument" originalExecutionId="execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <api:AllDocuments documentStatus="ANY"/>
  
  </object>
        </api:create>
     </soapenv:Body>
  </soapenv:Envelope>
  

  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:RerunDocument" originalExecutionId="execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01" requestId="executionrecord-1c2bbdc3-f456-78bd-9cee-0f1234cd52ff" recordUrl="https://qa.boomi.com/api/rest/v1/account123/ExecutionRecord/async/executionrecord-1c2bbdc3-f456-78bd-9cee-0f1234cd52ff">
              <bns:AllDocuments/>
              <bns:SelectedDocuments>
                 <bns:Document genericConnectorRecordId="A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzLTQ0MmEtYjVhNS0zM2NiNDM0OTQ0ZjctMjAyMS4wMi4xNzpjb25uZWN0b3ItMTMzN2MyOWYtZDBhZC00Y2Q1LTgxYWEtMjkzNzA2NmJhZTcy"/>
              </bns:SelectedDocuments>
           </result>
        </bns:createResponse>
     </S:Body>
  </S:Envelope>