Trade model: Bulk Order Action

This page describes the FX Integration API’s Bulk Order Action trade model, as defined in the file config/OrdersAdapter/Blade/DataSource/etc/trademodels.xml in the FX Integration API Kit.

This documentation is for the FX Integration API 3.39.0.

Trade models are XML-defined state machines used by the Java Trading API, the C Trading API, and Caplin Trader’s Trading API to manage trading workflows. For more information on trade model XML definitions, see the Trade model XML schema reference.

State diagram

The state diagram for the Bulk Order Action trade model is shown below. To simplify the diagram, the Timeout and Error states have been omitted.

InitialBulkActionSentProcessingDoneCancelledBulkActionSubmitBulkActionAckBulkActionCompletedCancelWaitLegendTransitions initiated by the client are inyellow.Transitions initiated by the server are inblue.

Messages: client → server

Trade-channel messages sent by StreamLink clients to the FX API DataSource.

BulkActionSubmit
MsgType
String
Example: BulkActionSubmit
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
BulkAction
The new state that we would like the order to switch to, e.g. Active, Inactive
OrderIDs
A comma separated list of the Order IDs to apply the action to
CancelWait
MsgType
String
Example: CancelWait
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model

Messages: server → client

Trade-channel messages sent by the FX API DataSource to StreamLink clients.

BulkActionAck
MsgType
String
Example: BulkActionAck
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
BulkActionCompleted
MsgType
String
Example: BulkActionCompleted
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model