Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - GenericConnectorRecord

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

GenericConnectorRecord

Use the Generic Connector Record object to programmatically retrieve document metadata for a given process execution by means of a GET and QUERY operation.

Note: This object 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 for viewing or retrieving process run details. For a deeper understanding into 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 Generic Connector Record represents the individual documents that are tracked for a given integration process run. Generic Connector Records are obtained through Start, connector, or Return Documents shapes. These records also include both standard connector and user-defined tracked document metadata. A typical usage pattern when using this object is to:

  1. Query for a particular ExecutionRecord record.
  2. Retrieve the ExecutionConnector records for that run record.
  3. Retrieve the GenericConnectorRecords for a particular ExecutionConnector record. This record is equivalent to viewing the details of a run through the Process Reporting page.

    Note: You can query Generic Connector Records within a single process run. You cannot query Generic Connector Records across all available runs at this time.

Retrieves an instance of a GenericConnectorRecord object

Allows you to view document metadata for exactly one document based on the provided id.

Authorizations:
basicAuth
path Parameters
id
required
string

The ID of the GenericConnectorRecord. You obtain this ID from querying the GenericConnectorRecord object.

Responses

Response Schema:
required
object (ConnectorFields)

Displays all connector-related fields from the connector included in this document.

errorMessage
required
string

Displays the corresponding error message for an unsuccessful document.

required
object (TrackedFields)

Displays all the custom tracked fields from this document.

account
string
actionType
string

The type of action the connector performs, for example, GET, SEND, LISTEN, and so on.

atomId
string

The ID of the Runtime in which the process ran. In the case of a Runtime cloud, use the ID of the Cloud attachment and not that of the Cloud itself.

connectionId
string

When sending documents into or out of the Connection component, use this ID.

connectionName
string

When sending documents into or out of the Connection component, use this user-defined name.

connectorType
string

The internal and unique identifier for the connector type the document was sent into or out of, such as http, ftp, or greatplains.

dateProcessed
string <date-time>

The processing date and time of the document.

documentIndex
integer <int32>

Index of the document within the context of its execution connector (starting from 0).

executionConnectorId
string

The ID of the Execution Connector object. This ID identifies the execution connector of which this document is a part.

executionId
string

The ID of the process run.

id
string

The ID of the GenericConnectorRecord. You obtain this ID from querying the GenericConnectorRecord object

incrementalDocumentIndex
integer <int32>

Index of the document in the context of the overall run (starting from 1).

operationId
string

When sending documents into or out of the Operation component, use this ID.

operationName
string

When sending documents into or out of the Operation component, use this user-defined name.

retryable
boolean

If the value is true, this indicates that you can rerun the document using the Rerun Document operation. If the value is false, this indicates that you cannot rerun the document using the Rerun Document operation.

size
integer <int64>

The size of the document in kilobytes.

startShape
boolean

If the value is true, this indicates the configuration of the Connector or Trading Partner as a Start shape in the process run. If the value is false, this indicates that you did not configure the Connector or Trading Partner as a Start shape in the process run.

status
string
Enum: "SUCCESS" "ERROR"

Indicates whether the document successfully or unsuccessfully ran.

Response samples

Content type
{
  • "@type": "GenericConnectorRecord",
  • "id": "A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzL...",
  • "executionConnectorId": "RVhFQ19DT05OZmFsc2U6U2VuZDp0cmFkaW5ncGFydG5l...",
  • "executionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01",
  • "atomId": "3456789a-bcde-f012-3456-789abcdef012",
  • "dateProcessed": "2021-02-23T16:44:50Z",
  • "actionType": "Get",
  • "connectorType": "http",
  • "connectionName": "Runtime API Endpoint: https://boomi.com/api/rest/v1/account123/Atom",
  • "operationName": "Get",
  • "connectionId": "1a2c34f5-fbf6-789b-01ea-234a56e7b890",
  • "operationId": "567b89e1-c234-5678-abff-9f01aee2345a",
  • "documentIndex": 0,
  • "incrementalDocumentIndex": 3,
  • "status": "SUCCESS",
  • "startShape": false,
  • "retryable": false,
  • "size": 133
}

Retrieves multiple GenericConnectorRecord objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (GenericConnectorRecord)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for a GenericConnectorRecord object(s)

  • The QUERY operation allows you to view document metadata for all documents in the run. You must query by exactly one executionId.
  • You cannot query connectorFields.

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: id, executionConnectorId, executionId, connectionId, operationId, actionType, connectorType, atomId, dateProcessed, connectionName, operationName, errorMessage, status, documentIndex, incrementalDocumentIndex, size, startShape, retryable

required
object
required
GenericConnectorRecordSimpleExpression (object) or GenericConnectorRecordGroupingExpression (object) (GenericConnectorRecordExpression)
One of
operator
required
string
Value: "EQUALS"
property
required
string
Enum: "id" "executionConnectorId" "executionId" "connectionId" "operationId" "actionType" "connectorType" "atomId" "dateProcessed" "connectionName" "operationName" "errorMessage" "status" "documentIndex" "incrementalDocumentIndex" "size" "startShape" "retryable"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (GenericConnectorRecord)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "@type": "GenericConnectorRecord",
  • "trackedFields": {
    • "@type": "TrackedFields",
    • "trackedField": [
      ]
    },
  • "connectorFields": {
    • "@type": "ConnectorFields",
    • "connectorField": [
      ]
    },
  • "id": "A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzLTQ0MmEtYjVhNS0zM2NiNDM0OTQ0ZjctMjAyMS4wMi4xNzpjb25uZWN0b3ItMTMzN2MyOWYtZDBhZC00Y2Q1LTgxYWEtMjkzNzA2NmJhZTcy",
  • "executionConnectorId": "RVhFQ19DT05OZmFsc2U6R2V0OjVlODAwNTU2LWQ4OGUtNDg3Mi05YTE3LTJmMWNjZGQ3MjgxYzo5ZjY0NDEwZS1jMWY1LTRhZDAtOTM1Zi0yZGFlNGJlOTcwNzc6ZXhlY3V0aW9uLTAxZTgxN2RiLTExNGUtNDQzNi1iOGFmLTc0YjdjZDIxNjg0OS0yMDIxLjAzLjA0",
  • "executionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01",
  • "atomId": "3456789a-bcde-f012-3456-789abcdef012",
  • "dateProcessed": "2021-03-04T13:40:36Z",
  • "actionType": "Get",
  • "connectorType": "disk",
  • "connectionName": "TestData",
  • "operationName": "Get txt file",
  • "connectionId": "1e234567-d88e-4872-9a17-2f1ccdd7281c",
  • "operationId": "6f78901e-c1f5-4ad0-935f-2dae4be97077",
  • "documentIndex": 3,
  • "incrementalDocumentIndex": 15,
  • "status": "SUCCESS",
  • "startShape": false,
  • "retryable": false,
  • "size": 657
}

Retrieves additional results for a GenericConnectorRecord query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (GenericConnectorRecord)

Response samples

Content type
{
  • "@type": "GenericConnectorRecord",
  • "trackedFields": {
    • "@type": "TrackedFields",
    • "trackedField": [
      ]
    },
  • "connectorFields": {
    • "@type": "ConnectorFields",
    • "connectorField": [
      ]
    },
  • "id": "A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzLTQ0MmEtYjVhNS0zM2NiNDM0OTQ0ZjctMjAyMS4wMi4xNzpjb25uZWN0b3ItMTMzN2MyOWYtZDBhZC00Y2Q1LTgxYWEtMjkzNzA2NmJhZTcy",
  • "executionConnectorId": "RVhFQ19DT05OZmFsc2U6R2V0OjVlODAwNTU2LWQ4OGUtNDg3Mi05YTE3LTJmMWNjZGQ3MjgxYzo5ZjY0NDEwZS1jMWY1LTRhZDAtOTM1Zi0yZGFlNGJlOTcwNzc6ZXhlY3V0aW9uLTAxZTgxN2RiLTExNGUtNDQzNi1iOGFmLTc0YjdjZDIxNjg0OS0yMDIxLjAzLjA0",
  • "executionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01",
  • "atomId": "3456789a-bcde-f012-3456-789abcdef012",
  • "dateProcessed": "2021-03-04T13:40:36Z",
  • "actionType": "Get",
  • "connectorType": "disk",
  • "connectionName": "TestData",
  • "operationName": "Get txt file",
  • "connectionId": "1e234567-d88e-4872-9a17-2f1ccdd7281c",
  • "operationId": "6f78901e-c1f5-4ad0-935f-2dae4be97077",
  • "documentIndex": 3,
  • "incrementalDocumentIndex": 15,
  • "status": "SUCCESS",
  • "startShape": false,
  • "retryable": false,
  • "size": 657
}