Write Operations

This operations category defines any operations that store or delete participants or business agreements in the configuration database.

The WRITE operations does the following:

Allow creation of new participants and business agreements
Delete existing participants or business agreements
Update participants or business agreements
Update enabled protocol specific properties and Operations Tree properties

Write operations follow the rules explained in Write Operation Rules.

Write Operation Rules

Write Operation

Rules and Descriptions

deleteBusinessAgreement

This operation allows the user to delete an existing business agreement.

deleteParticipant

This operation allows the user to delete an existing participant.

insertBusinessAgreement

This operation allows the user to insert a new business agreement.

insertParticipant

This operation allows the user to insert a new participant.

updateBusinessAgreement

This operation allows the user to update an existing business agreement.

updateEnabledProtocol

This operation allows you to set enabled protocol properties for a participant. The input schema for this operation is constructed when you click Update from Configuration Store on the BusinessConnect connection shared resource. The schema considers all the activated protocols in the configuration store.

On runtime, several checks are performed to verify whether the following is true:

The specified participant exists.
The participant is a partner if the 'partnerProtocols' element has been specified.
The participant is a host if the 'hostProtocols' element has been specified.
The protocols underneath, 'partnerProtocols' or 'hostProtocols', have been enabled for the participant.

updateOperationBinding

This operation allows the user to set the properties on a business agreement operation binding. The input schema for this operation is constructed when the user clicks 'Update from Configuration Store' on the BusinessConnect connection shared resource. The schema considers all the activated protocols in the configuration store.

On runtime, the following checks are performed to verify whether:

The business agreement exists.
The operation path corresponds to the request schema selected for the protocol and level.

updateOperationTree

This operation allows the user to set the properties on an operation tree node. The input schema for this operation is constructed when the user clicks 'Update from Configuration Store' on the BusinessConnect connection shared resource. The schema considers all the activated protocols in the configuration store.

On runtime, a check is performed to verify that the operation path corresponds to the request schema selected for the protocol and level.

updateParticipant

This operation allows the user to update an existing participant.

upsertBusinessAgreement

This operation allows the user to update an existing business agreement or insert a new one.

upsertParticipant

This operation allows the user to update an existing participant or insert a new one.