Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - X12ConnectorRecord

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

X12ConnectorRecord

X12 Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The X12 Connector Record object contains X12-specific document information and user-defined tracked field information along with other fields.

Required Privileges

You need these privileges in the target environment:

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.

Queries for a X12ConnectorRecord object

To filter by a custom field, use the format customFields. Use the fieldName as the filter property where fieldName is the element name of the custom field in the X12 Connector Record structure. To get a list of the available custom fields see the Custom Tracked Field object.

The STARTS_WITH operator only accepts values that do not include spaces.

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
X12ConnectorRecordSimpleExpression (object) or X12ConnectorRecordGroupingExpression (object) (X12ConnectorRecordExpression)
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: "executionId" "atomId" "dateProcessed" "id" "actionType" "connectorType" "connectorName" "operationName" "documentIndex" "successful" "size" "errorMessage" "isaAckStatus" "isaAckReport" "ackStatus" "ackReport" "isaControl" "gsControl" "stControl" "functionalID" "transactionSet" "testIndicator" "senderIDQualifier" "senderID" "receiverIDQualifier" "receiverID" "appSenderID" "appReceiverID" "standardID" "standard" "gsVersion" "agencyCode" "gsDate" "gsTime" "outboundValidationStatus" "outboundValidationReport"
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 (X12ConnectorRecord)

Request samples

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

Response samples

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

Retrieves additional results for a X12ConnectorRecord 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 (X12ConnectorRecord)

Response samples

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