EDI Custom Connector Record object

EDI Custom Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The EDI Custom Connector Record object contains the component names of the sending and receiving custom trading partners and user-defined tracked field information along with other fields.

Structure

<EDICustomConnectorRecord>
    <account/>
    <executionId/>
    <atomId/>
    <dateProcessed/>
    <id/>
    <actionType/>
    <connectorType/>
    <connectorName/>
    <operationName/>
    <documentIndex/>
    <successful/>
    <size/>
    <errorMessage/>
    <customFields>
        <field1>value</field1>
        .
        .
        .
        <fieldN>value</fieldN>
    </customFields>
    <fromTradingPartner/>
    <toTradingPartner/>
    <customStandardID/>
    <customStandardName/>
    <standardID/>
    <senderID/>
    <senderIDQualifier/>
    <receiverID/>
    <receiverIDQualifier/>
    <messageType/>
    <messageID/>
    <messageDate/>
    <messageTime/>
    <version/>   
</EDICustomConnectorRecord>

Field	Type	Description
Filter	Filter	Filter
account	string	The ID of the account that ran this record.
executionId	string	The ID of the run.
atomId	string	The ID of the Runtime that processed this record.
dateProcessed	string	The processing date and time of this record. Format is yyyy-MM-dd'T'HH:mm:ss'Z' (for example, 2019-09-14T15:32:00Z).
id	string	The ID of this record.
actionType	string	The type of action with which this record corresponds — Send for an outbound interchange, Get for an inbound interchange using the Disk, FTP, or SFTP communication method, or Listen for an inbound interchange using the AS2 or HTTP communication method.
connectorType	string	edicustom is the connector type for any record.
connectorName	string	The value is Trading Partner for a Custom trading partner Send operation, or Start for a Custom trading partner Listen operation.
operationName	string	The name of the operation component that processed the record.
documentIndex	int	The numerical index of this record in the execution.
successful	boolean	Whether the record is a success or error.
size	long	The size, in bytes, of the document that corresponds to this record.
errorMessage	string	Any error message associated with this record. This field is omitted for a successful interchange.
customFields	string	Custom fields based on the fields configured on the Document Tracking tab of the Setup page. The names of the fields are dependent upon your account setup.
fromTradingPartner	string	The name of the sending trading partner component.
toTradingPartner	string	The name of the receiving trading partner component.
customStandardID	string	The ID of the Custom Document Standard component used to extract tracked fields at runtime.
customStandardName	string	The name of the Custom Document Standard component.
standardID	string	The standardID specified in the Standard Identification tab of the Custom Document Standard component.
senderID	string	The value of the Sender ID field as extracted by the Custom Document Standard Field Extraction rules.
senderIDQualifier	string	The value of the Sender ID Qualifier field as extracted by the Custom Document Standard Field Extraction rules.
receiverID	string	The value of the Receiver ID field as extracted by the Custom Document Standard Field Extraction rules.
receiverIDQualifier	string	The value of the Receiver ID Qualifier field as extracted by the Custom Document Standard Field Extraction rules.
messageType	string	The value of the Message Type field as extracted by the Custom Document Standard Field Extraction rules.
messageID	string	The value of the Message ID field as extracted by the Custom Document Standard Field Extraction rules.
messageDate	string	The value of the Message Date field as extracted by the Custom Document Standard Field Extraction rules.
messageTime	string	The value of the Message Time field as extracted by the Custom Document Standard Field Extraction rules.
version	string	The value of the Version field as extracted by the Custom Document Standard Field Extraction rules.

Supported operations

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

You can use the following fields as QUERY filters for the EDI Custom Connector Record object:

Field	Allowed values
Filter	Filter
executionId	Any string value
atomId	Any string value
dateProcessed	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2019-09-14T15:32:00Z
id	Any string value
actionType	Send, Get, Listen
connectorType	edicustom
connectorName	Trading Partner to filter by Custom trading partner Send operations, Start to filter by Custom trading partner Listen operations
operationName	Trading Partner to filter by Custom trading partner Send operations, Start to filter by Custom trading partner Listen operations
documentIndex	Any numeric value
successful	true, false
size	Any numeric value
errorMessage	Any string value
fromTradingPartner	Any string value
toTradingPartner	Any string value
customStandardID	A standard Boomi component ID with a GUID format. For example, cc24de4d-72f6-4541-a358-e180ad4b2b13
customStandardName	Any string value
standardID	Any string value
senderID	Any string value
senderIDQualifier	Any string value
receiverID	Any string value
receiverIDQualifier	Any string value
messageType	Any string value
messageID	Any string value
messageDate	Any string value
messageTime	Any string value
version	Any string value

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

The operators allowed for the EDI Custom Connector Record object filters are:

BETWEEN
EQUALS
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
STARTS_WITH

However, note that the STARTS_WITH operator accepts values that do not include spaces only.

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

Sorting of the Query results are by the dateprocessed field value, from the oldest to the newest.

SOAP implementation

The following example query returns all EDI Custom Connector records with an executionId of execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14.

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>EDICustomConnectorRecord</api:objectType>
         <api:queryConfig>
             <api:QueryFilter>
               <api:expression operator="EQUALS" property="executionId"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                 <api:argument>execution-eda39aba-acee-438e-a6c0-54614e81a643-2025.10.07</api:argument>
               </api:expression>
             </api:QueryFilter>
         </api:queryConfig>
      </api:query>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <S:Body>
      <bns:queryResponse xmlns="http://api.platform.boomi.com/">
         <bns:results numberOfResults="100">
            <bns:queryToken>EXAMPLE_QUERY_TOKEN</bns:queryToken>
            <bns:result xsi:type="bns:EDICustomConnectorRecord">
              <bns:account>demo-2ZR33Z</bns:account>
              <bns:executionId>execution-eda39aba-acee-438e-a6c0-54614e81a643-2025.10.07</bns:executionId>
              <bns:atomId>16d22e86-bc07-444b-adc8-b4a1bb1b715c</bns:atomId>
              <bns:dateProcessed>2025-10-07T17:47:41Z</bns:dateProcessed>
              <bns:id>connector-7fdca144-5056-4110-838b-26c488277710</bns:id>
              <bns:actionType>Get</bns:actionType>
              <bns:connectorType>edicustom</bns:connectorType>
              <bns:connectorName>Start</bns:connectorName>
              <bns:operationName>shape1~4d126eb9-600c-4481-90a8-2bfe79b02ade</bns:operationName>
              <bns:documentIndex>2</bns:documentIndex>
              <bns:successful>true</bns:successful>
              <bns:size>675</bns:size>
              <bns:customFields>
                <bns:Purchase_Order_Number_1>PO01000</bns:Purchase_Order_Number_1>
              </bns:customFields>
              <bns:fromTradingPartner>Custom Simple Partner</bns:fromTradingPartner>
              <bns:toTradingPartner>Custom Simple MyCo</bns:toTradingPartner>
              <bns:customStandardID>340d6068-7142-468b-aafc-30006172b63d</bns:customStandardID>
              <bns:customStandardName>Simple</bns:customStandardName>
              <bns:standardID>Simple</bns:standardID>
              <bns:senderID>123456789</bns:senderID>
              <bns:senderIDQualifier>DUNS</bns:senderIDQualifier>
              <bns:receiverID>987654321</bns:receiverID>
              <bns:receiverIDQualifier>DUNS</bns:receiverIDQualifier>
              <bns:messageType>PurchaseOrder</bns:messageType>
              <bns:messageID>11111</bns:messageID>
              <bns:messageDate>10072025</bns:messageDate>
              <bns:messageTime>1347</bns:messageTime>
              <bns:version>1.2</bns:version>
            ...
            <bns:result xsi:type="bns:EDICustomConnectorRecord">
              <bns:account>demo-2ZR33Z</bns:account>
              <bns:executionId>execution-eda39aba-acee-438e-a6c0-54614e81a643-2025.10.07</bns:executionId>
              <bns:atomId>16d22e86-bc07-444b-adc8-b4a1bb1b715c</bns:atomId>
              <bns:dateProcessed>2025-10-07T17:47:41Z</bns:dateProcessed>
              <bns:id>connector-7fdca144-5056-4110-838b-26c488277710</bns:id>
              <bns:actionType>Get</bns:actionType>
              <bns:connectorType>edicustom</bns:connectorType>
              <bns:connectorName>Start</bns:connectorName>
              <bns:operationName>shape1~4d126eb9-600c-4481-90a8-2bfe79b02ade</bns:operationName>
              <bns:documentIndex>49</bns:documentIndex>
              <bns:successful>true</bns:successful>
              <bns:size>675</bns:size>
              <bns:customFields>
                <bns:Purchase_Order_Number_1>PO01000</bns:Purchase_Order_Number_1>
              </bns:customFields>
              <bns:fromTradingPartner>Custom Simple Partner</bns:fromTradingPartner>
              <bns:toTradingPartner>Custom Simple MyCo</bns:toTradingPartner>
              <bns:customStandardID>340d6068-7142-468b-aafc-30006172b63d</bns:customStandardID>
              <bns:customStandardName>Simple</bns:customStandardName>
              <bns:standardID>Simple</bns:standardID>
              <bns:senderID>123456789</bns:senderID>
              <bns:senderIDQualifier>DUNS</bns:senderIDQualifier>
              <bns:receiverID>987654321</bns:receiverID>
              <bns:receiverIDQualifier>DUNS</bns:receiverIDQualifier>
              <bns:messageType>PurchaseOrder</bns:messageType>
              <bns:messageID>11111</bns:messageID>
              <bns:messageDate>10072025</bns:messageDate>
              <bns:messageTime>1347</bns:messageTime>
              <bns:version>1.2</bns:version>
            </bns:result>
         </bns:results>
      </bns:queryResponse>
   </S:Body>
</S:Envelope>

The maximum number of results returned per QUERY 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.

Structure​

Supported operations​

SOAP implementation​

Structure

Supported operations

SOAP implementation