Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - OFTP2ConnectorRecord

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

OFTP2ConnectorRecord

OFTP2 Connector Records correspond to the document and trading partner details of the Process Reporting page. Processes send OFTP2 messages using the OFTP2 Client connector and receive OFTP2 messages using the OFTP2 Server connector. The OFTP2 Connector Record object contains OFTP2-specific document information and user-defined tracked field informtaion along with other fields.

Queries for an OFTP2ConnectorRecord object

  • To filter by customFields, use the format customFields/fieldName as the filter property, where fieldName is the element name of the custom field in the OFTP2 Connector Record structure. To get a list of the available custom fields, refer to the CustomTrackedField.
  • The STARTS_WITH operator accepts values that do not include spaces.
  • Sorting of the QUERY results are by the dateProcessed field value, from the oldest to the newest.

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
required
object
required
OFTP2ConnectorRecordSimpleExpression (object) or OFTP2ConnectorRecordGroupingExpression (object) (OFTP2ConnectorRecordExpression)
One of
operator
required
string
Enum: "EQUALS" "STARTS_WITH" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL"
property
required
string
Enum: "sfiddsn" "sfiddate" "sfidtime" "sfiddest" "initiator_ssidcode" "responder_ssidcode" "sfidorig" "sfidsec" "sfidcomp" "sfidciph" "sfiddesc" "sfidsign" "sfidosiz" "sfidenv" "status" "account" "executionId" "atomId" "dateProcessed" "id" "actionType" "connectorType" "connectorName" "operationName" "documentIndex" "successful" "size" "customFields" "nareas" "nareast"
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 (OFTP2ConnectorRecord)

Request samples

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

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      }
    ],
  • "numberOfResults": 1
}

Retrieves additional results for an OFTP2ConnectorRecord query

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

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

Query token from the previous query response used to retrieve the next page of results.

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 (OFTP2ConnectorRecord)

Request samples

Content type
text/plain
/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a....

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      }
    ],
  • "numberOfResults": 1
}