Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - HL7ConnectorRecord

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

HL7ConnectorRecord

HL7 Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The HL7 Connector Record object contains HL7-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 HL7ConnectorRecord object(s)

To filter by a customField, use the format customFields.fieldName as the filter property where fieldName is the element name of the custom field in the HL7 Connector Record structure. To get a list of the available custom fields, refer to CustomTrackedField object.

The STARTS_WITH operator 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
HL7ConnectorRecordSimpleExpression (object) or HL7ConnectorRecordGroupingExpression (object) (HL7ConnectorRecordExpression)
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
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 (HL7ConnectorRecord)

Request samples

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

Response samples

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

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

Response samples

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