Read Operations

Read operations follow the rules explained in Read Operation Rules.

Read Operation Rules

Read Operation

Rules and Descriptions

getOneBusinessAgreement

Search is based on the name attribute value of the root element GETONEBusinessAgreementREQ.

The rules are:

Other attributes or elements are ignored.
Sorting is not supported.

getOneEnabledProtocol

This operation allows the user to read the enabled protocol properties of a participant.

The response is given as property key value pairs.

getOneOperationBinding

This operation allows the user to read the properties on a business agreement operation binding.

The response is given in a form of property key value pairs.

getOneOperationTree

This operation allows the user to read the properties on an operation tree node.

The response is given in a form of property key value pairs.

getOneParticipant

Search is based on the name attribute value of the root element GETONEParticipantREQ.

The rules are:

Other attributes or elements are ignored
The search is always accurate and returns one GETONEParticipantRESP response.

Searching for a participant based on a domain ID or AS2 ID yields results only when this participant has a domain ID or AS2 ID assigned to it. This search works for protocols that support domain IDs or AS2 IDs. For these situations, only searching by name is applicable.

getManyAuditLog

Search criteria to retrieve one or more results when the required parameters protocolName, startDate, and endDate are provided. The rules are:

How many rows are returned can be restricted by the size attribute.
You can set the criteria by field names of that protocol, values to search, or based on operation condition like contains, is, is not and is not like.
You can set the criteria based on the status and host attributes that are not required
Results are returned as name-value attribute pairs to be protocol agnostic.

getManyBusinessAgreement

Search is based on the name attribute value of the root element GETMANYBusinessAgreementREQ. The rules are:

Other attributes or elements are ignored.
Wildcard search is allowed and based on partner names; for example, Company* returns all business agreements containing this string, such as Company1-Company2 businessagreement, where Company1 is the Host and Company2 is the Partner.
Sorting is not supported.

getManyParticipant

Search is based on the name attribute value of the root element GETMANYParticipantREQ. The rules are:

Other attributes or elements are ignored.
Wildcard search is allowed; for example, the string *y* would return all the participants containing *y*, such as Company1.
Sorting is not supported.

Searching for a participant based on a domain ID or AS2 ID yields results only when this participant has a domain ID or AS2 ID assigned to it. This search works for protocols that support domain IDs or AS2 IDs. For these situations, only search by name is applicable.

getManyProtocolOperation

This operation returns all operations for a particular protocol. The rule is:

Multiple protocol operations can be returned by specifying multiple protocols.