Execution Record object

Execution records correspond to the Executions search on the Process Reporting page in the user interface. The Execution Record object contains information about a process run, including the run date, status, process information, Runtime information, and error messages along with other fields.

Structure

<ExecutionRecord>
    <executionId/>
    <originalExecutionId/>
    <account/>
    <executionTime/>
    <status/>
    <executionType/>
    <processName/>
    <processId/>
    <atomName/>
    <atomId/>
    <inboundDocumentCount/>
    <inboundErrorDocumentCount/>
    <outboundDocumentCount/>
    <executionDuration/>
    <message/>
    <parentExecutionId/>
    <topLevelExecutionId/>
    <inboundDocumentSize/>
    <outboundDocumentSize/>
    <launcherID/>
    <reportKey/>
    <nodeId/>
</ExecutionRecord>

Field	Type	Description
executionId	string	The ID of the execution.
originalExecutionId	string	The original execution ID, if this execution is a retry.
account	string	The ID of the account in which you ran this execution.
executionTime	dateTime - yyyy-MM-dd'T'HH:mm:ss'Z' For example, 2016-01-31T15:32:00Z	The start date and time this run.
status	string	The status of the run. Possible values are: - ABORTED - ABORTED_RECOVERING - COMPLETE - COMPLETE_WARN - DISCARDED - ENQUEUED - ERROR - INPROCESS - STARTED
executionType	string	Indicates how initiation of the process run occurred. Possible values are: - exec_listener (run initiated by a listener request) - exec_manual (manual run) - exec_sched (scheduled run) - retry_manual (manual retry) - retry_sched (scheduled retry) - sub_process (subprocess call) - test_manual (test mode run)
processName	string	The name of the run process.
processId	string	The ID of the run process.
atomName	string	The name of the Atom on which the process ran.
atomId	string	The ID of the Runtime the on which the process ran.
inboundDocumentCount	int	The number of processed inbound documents.
inboundErrorDocumentCount	int	The number of processed inbound documents with errors.
outboundDocumentCount	int	The number of processed outbound documents.
executionDuration	long	The number of milliseconds it took to run the process.
message	string	Any error message returned from the run.
parentExecutionId	string	The ID of the run of the parent process, if this run and the parent process’ run were both subprocesses.
topLevelExecutionId	string	The ID of the run of the top-level process, if this run is a subprocess.
inboundDocumentSize	long	The aggregate size in bytes of the processed inbound documents.
outboundDocumentSize	long	The aggregate size in bytes of the processed outbound documents.
launcherID	string	The API Service component that kicks off the run. Note: The Runtime must have the API Type set to Advanced on the Shared Web Server tab of Runtime Management to specify the launcherID.
reportKey	string	The web service user that authenticated to make the run request. Note: For Runtimes with an Authentication Type of External Provider, the reportKey is the API Key. Otherwise, it is the specified user name.
nodeId	string	The ID of the Runtime cluster node in which the run occurred for a process run in a Runtime cluster or Runtime cloud. For a run occurring in a Runtime, this field is omitted.
recordedDate	dateTime - yyyy-MM-dd'T'HH:mm:ss'Z' For example, 2016-01-31T15:32:00Z	The end time when the process execution completes.

Supported operations

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

You can use the following fields as QUERY filters for the Execution Record object:

Field	Allowed values
executionId	Any string value
originalExecutionId	Any string value
account	Any string value
executionTime	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z' For example, 2016-01-31T15:32:00Z
status	ABORTED, COMPLETE, COMPLETE_WARN, DISCARDED, ERROR, INPROCESS, or STARTED
executionType	exec_listener, exec_manual, exec_sched, retry_manual, retry_sched, sub_process, test_manual
processName	Any string value
processId	Any string value
atomName	Any string value
atomId	Any string value
inboundDocumentCount	Integer
outboundDocumentCount	Integer
executionDuration	long integer
message	Any string value
launcherId	Any string value. Specifying a value that is not a valid API Service component will not return a useful result. Note: The field is specified in a filter expression as launcherId even though the actual field name is launcherID.
reportKey	Any string value. Specifying a value that is not a valid API Key will not return a useful result.
nodeId	Any string value.
recordedDate	Date with format yyyy-MM-dd'T'HH:mm:ss'Z' For example, 2016-01-31T15:32:00Z

Using the GET operation

• Use the GET operation with the Execution Request object. You use the Execution Request object to asynchronously run an integration process on a given Atom using a CREATE operation. Therefore, the Execution Record GET operation allows you to poll for when the run request is complete.

• The Execution Request object POST response returns a requestId. Use the requestId in a subsequent call to the Execution Record object, which provides a record of the successful process run.

• Repeatedly poll the Execution Record object with requestId until the run record is available. If the ExecutionRecord is not available, it returns an HTTP 202 status code. When the ExecutionRecord is available, it returns the Execution Record object's payload.

  note

  For long running processes, you may need to continue to poll ExecutionRecord until it returns a completed status such as COMPLETE or ERROR.

Using the QUERY operation

• The operators allowed for the Execution Record object filters are:

  • BETWEEN

  • EQUALS

  • GREATER_THAN

  • GREATER_THAN_OR_EQUAL

  • LESS_THAN

  • LESS_THAN_OR_EQUAL

  • LIKE

• For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

SOAP implementation

Important: Boomi does not currently support a SOAP implementation for GET operations.

QUERY operation

The following example query returns all run records in descending order.

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:query>
         <api:objectType>ExecutionRecord</api:objectType>
         <api:queryConfig>
            <api:QueryFilter>
               <api:expression operator="or" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression">
                  
                  <api:nestedExpression operator="EQUALS" property="processId" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                     <api:argument>5c94d512-4dfe-404b-b32a-8063259436f7</api:argument>
                  </api:nestedExpression>
                  
                  <api:nestedExpression operator="EQUALS" property="processId" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                     <api:argument>794ba65b-c2e2-4e6f-a80b-2df4680075fb</api:argument>
                  </api:nestedExpression>
                  
                  <api:nestedExpression operator="EQUALS" property="processId" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                     <api:argument>16dfdfdc-937a-42ea-af0e-a62e7ed73963</api:argument>
                  </api:nestedExpression>
               </api:expression>
            </api:QueryFilter>
           <api:QuerySort>
              <api:sortField fieldName="executionTime" sortOrder="DESC" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
              </api:sortField>
            </api:QuerySort>
         </api:queryConfig>
      </api:query>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
     <bns:queryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"          xmlns:bns="http://api.platform.boomi.com/">
      <bns:results numberOfResults="3">
         <bns:result xsi:type="bns:ExecutionRecord">
            <bns:executionId>execution-b10c08ca-46c6-4cf4-b30d-ba2be5ebb404-2024.09.25</bns:executionId>
            <bns:account>Boomi-123</bns:account>
            <bns:executionTime>2024-09-25T06:33:16Z</bns:executionTime>
             <bns:status>COMPLETE</bns:status>
             <bns:executionType>exec_manual</bns:executionType>
             <bns:processName>Test Process Status</bns:processName>
             <bns:processId>5c94d512-4dfe-404b-b32a-8063259436f7</bns:processId>
             <bns:atomName>Biggie</bns:atomName>
             <bns:atomId>05362201-cf51-4fef-95eb-ae1f0b8e7273</bns:atomId>
             <bns:inboundDocumentCount>1</bns:inboundDocumentCount>
             <bns:inboundErrorDocumentCount>0</bns:inboundErrorDocumentCount>
             <bns:outboundDocumentCount>0</bns:outboundDocumentCount>
             <bns:executionDuration>4009</bns:executionDuration>
             <bns:inboundDocumentSize>0</bns:inboundDocumentSize>
             <bns:outboundDocumentSize>0</bns:outboundDocumentSize>
             <bns:nodeId>172_16_21_144[execution-b10c08ca-46c6-4cf4-b30d-ba2be5ebb404-2024.09.25]</bns:nodeId>
             <bns:recordedDate>2024-09-25T06:33:20Z</bns:recordedDate>
             </bns:result>
           <bns:result xsi:type="bns:ExecutionRecord">
            <bns:executionId>execution-64beda8a-4aae-4bb8-85ba-2618458fb2be-2024.09.25</bns:executionId>
            <bns:account>Boomi-123</bns:account>
            <bns:executionTime>2024-09-25T06:33:59Z</bns:executionTime>
            <bns:status>COMPLETE</bns:status>
            <bns:executionType>exec_manual</bns:executionType>
            <bns:processName>Test Process-2</bns:processName>
            <bns:processId>5c94d512-4dfe-404b-b32a-8063259436f7</bns:processId>
            <bns:atomName>Chips</bns:atomName>
            <bns:atomId>05362201-cf51-4fef-95eb-ae1f0b8e7273</bns:atomId>
            <bns:inboundDocumentCount>1</bns:inboundDocumentCount>
            <bns:inboundErrorDocumentCount>0</bns:inboundErrorDocumentCount>
            <bns:outboundDocumentCount>0</bns:outboundDocumentCount>
            <bns:executionDuration>4221</bns:executionDuration>
            <bns:inboundDocumentSize>0</bns:inboundDocumentSize>
            <bns:outboundDocumentSize>0</bns:outboundDocumentSize>
            <bns:nodeId>172_16_21_144[execution-64beda8a-4aae-4bb8-85ba-2618458fb2be-2024.09.25]</bns:nodeId>
            <bns:recordedDate>2024-09-25T06:34:04Z</bns:recordedDate>
            </bns:result>
         <bns:result xsi:type="bns:ExecutionRecord">
           <bns:executionId>execution-dc1d980a-c2fa-46fa-9b6d-23023450f058-2024.09.25</bns:executionId>
           <bns:account>Boomi-123</bns:account>
           <bns:executionTime>2024-09-25T06:34:14Z</bns:executionTime>
           <bns:status>COMPLETE</bns:status>
           <bns:executionType>exec_manual</bns:executionType>
           <bns:processName>Process Status Check</bns:processName>
           <bns:processId>5c94d512-4dfe-404b-b32a-8063259436f7</bns:processId>
           <bns:atomName>Biggie</bns:atomName>
           <bns:atomId>05362201-cf51-4fef-95eb-ae1f0b8e7273</bns:atomId>
           <bns:inboundDocumentCount>1</bns:inboundDocumentCount>
           <bns:inboundErrorDocumentCount>0</bns:inboundErrorDocumentCount>
           <bns:outboundDocumentCount>0</bns:outboundDocumentCount>
           <bns:executionDuration>3874</bns:executionDuration>
           <bns:inboundDocumentSize>0</bns:inboundDocumentSize>
           <bns:outboundDocumentSize>0</bns:outboundDocumentSize>
           <bns:nodeId>172_16_21_144[execution-dc1d980a-c2fa-46fa-9b6d-23023450f058-2024.09.25]</bns:nodeId>
           <bns:recordedDate>2024-09-25T06:34:18Z</bns:recordedDate>
           </bns:result>
          </bns:results>
        </bns:queryResponse>
    </S:Body>
</S:Envelope>

The maximum number of results returned per QUERY operation response is 100. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.