FIXEdge Administrative REST API
FIXEdge Administrative REST API
Version: 1.1.0
BasePath:
All rights reserved.
https://www.b2bits.com/trading_solutions/license.aspx
Access
[ Jump to Models ]
Table of Contents
Up
get /business_layer/routing_rules
(getBLRules)
Get content of BL_config.xml configuration file
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
String
500
Operation failed
Up
post /business_layer/routing_rules/reload
(reloadBusinessLayerRoutingRules)
Reloads business layer routing rules.
Query parameters
history (optional)
Query Parameter — reload history or not default: null
Return type
Example data
Content-Type: application/json
{
"component" : "component",
"error" : "error"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
empty JSON array if OK, otherwise list of errors occured
BLError
500
An exception was generated by business layer
Up
put /business_layer/routing_rules
(setBLRules)
Set content of BL_config.xml configuration file
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
500
Operation failed
Up
post /managed_queues/egress/{queueName}/flush
(flushEgressQueue)
Remove all queued messages
Path parameters
queueName (required)
Path Parameter — identifier of managed queue default: null
Responses
200
OK
400
Managed queue is not registered
500
The storage is not initialized
Up
get /managed_queues/egress
(getAllEgressQueues)
Get list of egress managed queues on FIX layer
Return type
Example data
Content-Type: application/json
{
"QueuedMessages" : 0,
"OnHold" : true,
"TargetSession" : "TargetSession",
"QueueName" : "QueueName",
"IsProcessing" : true,
"ScheduleName" : "ScheduleName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Up
get /managed_queues/schedules
(getAllManagedQueuesSchedules)
List all available schedules
Return type
Example data
Content-Type: application/json
{
"ScheduleName" : "ScheduleName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
NamedScheduleConfig
500
Operation failed
Up
get /managed_queues/egress/{queueName}
(getEgressQueueByName)
Obtain information about egress queue by its name
Path parameters
queueName (required)
Path Parameter — identifier of managed queue default: null
Return type
Example data
Content-Type: application/json
{
"QueuedMessages" : 0,
"OnHold" : true,
"TargetSession" : "TargetSession",
"QueueName" : "QueueName",
"IsProcessing" : true,
"ScheduleName" : "ScheduleName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
QueueStatus
400
Managed queue is not registered
500
The storage is not initialized
Up
get /managed_queues/egress/{queueName}/messages
(getEgressQueueMessages)
Obtain messages from egress queue by its name
Path parameters
queueName (required)
Path Parameter — identifier of managed queue default: null
Return type
Example data
Content-Type: application/json
{
"ClOrdID" : "ClOrdID",
"ClientID" : "ClientID",
"MessageText" : "MessageText",
"MessageType" : "MessageType",
"MessageId" : 0,
"EnqueuedTimestamp" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
400
Managed queue is not registered
500
The storage is not initialized
Up
post /managed_queues/egress/{queueName}/hold
(holdEgressQueue)
Put managed queue on hold. Queued messages will not be delivered
until hold is manually released
Path parameters
queueName (required)
Path Parameter — identifier of managed queue default: null
Responses
200
OK
400
Managed queue is not registered
500
The storage is not initialized
Up
delete /managed_queues/egress/{queueName}/messages
(removeEgressQueueMessages)
Delete messages from egress queue by message IDs
Path parameters
queueName (required)
Path Parameter — identifier of managed queue default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"IsRemoved" : true,
"MessageId" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
400
Managed queue is not registered
500
The storage is not initialized
Up
delete /managed_queues/egress/{queueName}/hold
(unholdEgressQueue)
Release hold from queue. Queued messages will be immediately
delivered if managed queue is not processing at the moment
Path parameters
queueName (required)
Path Parameter — identifier of managed queue default: null
Responses
200
OK
400
Managed queue is not registered
500
The storage is not initialized
Up
post /schedules/{scheduleName}
(addSchedule)
Add new schedule
Path parameters
scheduleName (required)
Path Parameter — identifier of the schedule default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
500
Operation failed
(getAllSchedules)
List all available schedules
Return type
Example data
Content-Type: application/json
{
"ScheduleName" : "ScheduleName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
NamedScheduleConfig
500
Operation failed
Up
get /schedules/{scheduleName}
(getSchedule)
Get schedule parameters
Path parameters
scheduleName (required)
Path Parameter — identifier of the schedule default: null
Return type
Example data
Content-Type: application/json
{
"ScheduleName" : "ScheduleName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
NamedScheduleConfig
404
Schedule with given name does not exist
500
Operation failed
Up
put /schedules/{scheduleName}
(modifySchedule)
Modify existing schedule
Path parameters
scheduleName (required)
Path Parameter — identifier of the schedule default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
404
Schedule with given name does not exist
500
Operation failed
Up
delete /schedules/{scheduleName}
(removeSchedule)
Remove existing schedule
Path parameters
scheduleName (required)
Path Parameter — identifier of the schedule default: null
Responses
200
OK
404
Schedule with given name does not exist
500
Operation failed
(isServiceRunning)
Check if service is running and finished initialization
Responses
200
OK
404
Serivce is not fully initialized yet
Up
delete /service/started
(shutdownService)
Shutdown service
Responses
200
OK
Up
post /sessions/sender/{sender}/target/{target}
Create new session (addSessionById)
Creates new session with given sender and target. For detailed description of
remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.
Note that for initiator sessions properties RemoteHost, RemotePort and HBI are required.
These properties are ignored for acceptor sessions.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request (e.g. mandatory parameters are missing)
500
Failure to create a session (e.g. sessions with the specified name already exists)
Create new session (addSessionByIdFromJSON)
Creates new session with given sender, target and optional qualifier from JSON body. For detailed
description of remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.
Note that for initiator sessions properties RemoteHost, RemotePort and HBI are required.
These properties are ignored for acceptor sessions.
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request (e.g. mandatory parameters are missing)
500
Failure to create a session (e.g. sessions with the specified name already exists)
Up
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}
Create new session (addSessionByQualifiedId)
Creates new session with given sender, target and qualifier. For detailed description of
remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.
Note that for initiator sessions properties RemoteHost, RemotePort and HBI are required.
These properties are ignored for acceptor sessions.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request (e.g. mandatory parameters are missing)
500
Failure to create a session (e.g. sessions with the specified name already exists)
Get list of all sessions (getAllSessions)
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"IncomingMessagesLimit" : 0,
"StorageType" : "StorageType",
"InSeqNum" : 1,
"RemotePort" : 39501,
"OutgoingQueueSizeLimit" : 0,
"TargetCompID" : "TargetCompID",
"IncomingThroughputLimit" : 0,
"AsyncProcessing" : true,
"RecreateOnLogout" : true,
"AsyncProcessingQueueSizeLimit" : 0,
"SSL" : true,
"ConfiguredName" : "ConfiguredName",
"HBI" : 0,
"ExtraParams" : {
"SenderSubId" : "SenderSubId",
"ReconnectInterval" : 0,
"MessagesStorageSize" : "",
"DisableTCPBuffer" : true,
"SocketSendBufSize" : 0,
"SuppressDoubleResendRequest" : true,
"MaskedTags" : [ "MaskedTags", "MaskedTags" ],
"ResendRequestBlockSize" : 1,
"CyclicSwitchBackupConnection" : true,
"RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
"Validation" : {
"ProhibitUnknownTags" : false,
"AllowZeroNumInGroup" : true,
"IgnoreUnknownFields" : true,
"IsEnabled" : true,
"ProhibitDuplicatedTags" : true,
"CheckRequiredGroupFields" : true,
"ProhibitTagsWithoutValue" : true,
"VerifyTagsValues" : false,
"VerifyRepeatingGroupBounds" : false
},
"SendCpuAffinity" : 0,
"EncryptMethod" : "NONE",
"StorageType" : "StorageType",
"UserNameTag" : 0,
"CustomSessionType" : "CustomSessionType",
"LogIncomingMessages" : true,
"AggressiveReceiveDelay" : "",
"HandleSeqNumAtLogon" : true,
"SendLastMsgSeqNumProcessed" : true,
"SocketPriority" : "SocketPriority",
"SenderLocationID" : "SenderLocationID",
"LogonMessageSessionQualifierTag" : 0,
"KeepConnectionState" : true,
"SendingTimestampUnit" : "SendingTimestampUnit",
"Transport" : "Transport",
"SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
"ReconnectMaxTries" : 0,
"IgnoreSeqNumTooLowAtLogon" : true,
"ConnectPort" : 48874,
"ValidateCheckSum" : true,
"AllowMessageWithoutPossDupFlag" : true,
"ForcedReconnect" : true,
"SocketBusyPollTime" : 0,
"DeliverAppMessagesOutOfOrder" : true,
"TargetSubId" : "TargetSubId",
"TargetLocationID" : "TargetLocationID",
"PasswordTag" : 0,
"MaxMessagesAmountInBunch" : 0,
"FixKey" : "FixKey",
"GenerateCheckSum" : true,
"HiddenLogonCredentials" : true,
"Password" : "Password",
"UseBlockingSockets" : true,
"CpuAffinity" : 0,
"SocketRecvBufSize" : 0,
"EnableMessageRejecting" : true,
"StorageRecoveryStrategy" : "StorageRecoveryStrategy",
"UseAsyncConnect" : true,
"IntradayLogoutToleranceMode" : true,
"ConnectAddress" : "ConnectAddress",
"Username" : "Username",
"ForceSeqNumReset" : "NA",
"EnableAutoSwitchToBackupConnection" : true
},
"OutSeqNum" : 1,
"AppProtocolBaseVersion" : "AppProtocolBaseVersion",
"SSLCheckPrivateKey" : true,
"Qualifier" : "Qualifier",
"TerminateOnLogout" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Up
get /sessions/state/dynamic
Get list of all sessions (getAllSessionsStream)
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionsDataEvent
Up
get /sessions/sender/{sender}/target/{target}/output-messages
(getOutputMessagesOfSessionById)
Reads last 1000 output messages for the session. The messages are returns as JSON array, each element of the
array contains a Base64 encoded FIX message.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Return type
array[byte[]]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Up
get /sessions/{configuredName}/output-messages
(getOutputMessagesOfSessionByName)
Reads last 1000 output messages for the session. The messages are returns as JSON array, each element of the
array contains a Base64 encoded FIX message.
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Return type
array[byte[]]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Up
get /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/output-messages
(getOutputMessagesOfSessionByQualifiedId)
Reads last 1000 output messages for the session. The messages are returns as JSON array, each element of the
array contains a Base64 encoded FIX message.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Return type
array[byte[]]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Up
get /sessions/sender/{sender}/target/{target}
Get info on single session (getSessionById)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"IncomingMessagesLimit" : 0,
"StorageType" : "StorageType",
"InSeqNum" : 1,
"RemotePort" : 39501,
"OutgoingQueueSizeLimit" : 0,
"TargetCompID" : "TargetCompID",
"IncomingThroughputLimit" : 0,
"AsyncProcessing" : true,
"RecreateOnLogout" : true,
"AsyncProcessingQueueSizeLimit" : 0,
"SSL" : true,
"ConfiguredName" : "ConfiguredName",
"HBI" : 0,
"ExtraParams" : {
"SenderSubId" : "SenderSubId",
"ReconnectInterval" : 0,
"MessagesStorageSize" : "",
"DisableTCPBuffer" : true,
"SocketSendBufSize" : 0,
"SuppressDoubleResendRequest" : true,
"MaskedTags" : [ "MaskedTags", "MaskedTags" ],
"ResendRequestBlockSize" : 1,
"CyclicSwitchBackupConnection" : true,
"RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
"Validation" : {
"ProhibitUnknownTags" : false,
"AllowZeroNumInGroup" : true,
"IgnoreUnknownFields" : true,
"IsEnabled" : true,
"ProhibitDuplicatedTags" : true,
"CheckRequiredGroupFields" : true,
"ProhibitTagsWithoutValue" : true,
"VerifyTagsValues" : false,
"VerifyRepeatingGroupBounds" : false
},
"SendCpuAffinity" : 0,
"EncryptMethod" : "NONE",
"StorageType" : "StorageType",
"UserNameTag" : 0,
"CustomSessionType" : "CustomSessionType",
"LogIncomingMessages" : true,
"AggressiveReceiveDelay" : "",
"HandleSeqNumAtLogon" : true,
"SendLastMsgSeqNumProcessed" : true,
"SocketPriority" : "SocketPriority",
"SenderLocationID" : "SenderLocationID",
"LogonMessageSessionQualifierTag" : 0,
"KeepConnectionState" : true,
"SendingTimestampUnit" : "SendingTimestampUnit",
"Transport" : "Transport",
"SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
"ReconnectMaxTries" : 0,
"IgnoreSeqNumTooLowAtLogon" : true,
"ConnectPort" : 48874,
"ValidateCheckSum" : true,
"AllowMessageWithoutPossDupFlag" : true,
"ForcedReconnect" : true,
"SocketBusyPollTime" : 0,
"DeliverAppMessagesOutOfOrder" : true,
"TargetSubId" : "TargetSubId",
"TargetLocationID" : "TargetLocationID",
"PasswordTag" : 0,
"MaxMessagesAmountInBunch" : 0,
"FixKey" : "FixKey",
"GenerateCheckSum" : true,
"HiddenLogonCredentials" : true,
"Password" : "Password",
"UseBlockingSockets" : true,
"CpuAffinity" : 0,
"SocketRecvBufSize" : 0,
"EnableMessageRejecting" : true,
"StorageRecoveryStrategy" : "StorageRecoveryStrategy",
"UseAsyncConnect" : true,
"IntradayLogoutToleranceMode" : true,
"ConnectAddress" : "ConnectAddress",
"Username" : "Username",
"ForceSeqNumReset" : "NA",
"EnableAutoSwitchToBackupConnection" : true
},
"OutSeqNum" : 1,
"AppProtocolBaseVersion" : "AppProtocolBaseVersion",
"SSLCheckPrivateKey" : true,
"Qualifier" : "Qualifier",
"TerminateOnLogout" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionData
500
Session with the specified name does not exists
Up
get /sessions/{configuredName}
Get info on single session (getSessionByName)
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"IncomingMessagesLimit" : 0,
"StorageType" : "StorageType",
"InSeqNum" : 1,
"RemotePort" : 39501,
"OutgoingQueueSizeLimit" : 0,
"TargetCompID" : "TargetCompID",
"IncomingThroughputLimit" : 0,
"AsyncProcessing" : true,
"RecreateOnLogout" : true,
"AsyncProcessingQueueSizeLimit" : 0,
"SSL" : true,
"ConfiguredName" : "ConfiguredName",
"HBI" : 0,
"ExtraParams" : {
"SenderSubId" : "SenderSubId",
"ReconnectInterval" : 0,
"MessagesStorageSize" : "",
"DisableTCPBuffer" : true,
"SocketSendBufSize" : 0,
"SuppressDoubleResendRequest" : true,
"MaskedTags" : [ "MaskedTags", "MaskedTags" ],
"ResendRequestBlockSize" : 1,
"CyclicSwitchBackupConnection" : true,
"RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
"Validation" : {
"ProhibitUnknownTags" : false,
"AllowZeroNumInGroup" : true,
"IgnoreUnknownFields" : true,
"IsEnabled" : true,
"ProhibitDuplicatedTags" : true,
"CheckRequiredGroupFields" : true,
"ProhibitTagsWithoutValue" : true,
"VerifyTagsValues" : false,
"VerifyRepeatingGroupBounds" : false
},
"SendCpuAffinity" : 0,
"EncryptMethod" : "NONE",
"StorageType" : "StorageType",
"UserNameTag" : 0,
"CustomSessionType" : "CustomSessionType",
"LogIncomingMessages" : true,
"AggressiveReceiveDelay" : "",
"HandleSeqNumAtLogon" : true,
"SendLastMsgSeqNumProcessed" : true,
"SocketPriority" : "SocketPriority",
"SenderLocationID" : "SenderLocationID",
"LogonMessageSessionQualifierTag" : 0,
"KeepConnectionState" : true,
"SendingTimestampUnit" : "SendingTimestampUnit",
"Transport" : "Transport",
"SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
"ReconnectMaxTries" : 0,
"IgnoreSeqNumTooLowAtLogon" : true,
"ConnectPort" : 48874,
"ValidateCheckSum" : true,
"AllowMessageWithoutPossDupFlag" : true,
"ForcedReconnect" : true,
"SocketBusyPollTime" : 0,
"DeliverAppMessagesOutOfOrder" : true,
"TargetSubId" : "TargetSubId",
"TargetLocationID" : "TargetLocationID",
"PasswordTag" : 0,
"MaxMessagesAmountInBunch" : 0,
"FixKey" : "FixKey",
"GenerateCheckSum" : true,
"HiddenLogonCredentials" : true,
"Password" : "Password",
"UseBlockingSockets" : true,
"CpuAffinity" : 0,
"SocketRecvBufSize" : 0,
"EnableMessageRejecting" : true,
"StorageRecoveryStrategy" : "StorageRecoveryStrategy",
"UseAsyncConnect" : true,
"IntradayLogoutToleranceMode" : true,
"ConnectAddress" : "ConnectAddress",
"Username" : "Username",
"ForceSeqNumReset" : "NA",
"EnableAutoSwitchToBackupConnection" : true
},
"OutSeqNum" : 1,
"AppProtocolBaseVersion" : "AppProtocolBaseVersion",
"SSLCheckPrivateKey" : true,
"Qualifier" : "Qualifier",
"TerminateOnLogout" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionData
500
Session with the specified name does not exists
Up
get /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}
Get info on single session (getSessionByQualifiedId)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"IncomingMessagesLimit" : 0,
"StorageType" : "StorageType",
"InSeqNum" : 1,
"RemotePort" : 39501,
"OutgoingQueueSizeLimit" : 0,
"TargetCompID" : "TargetCompID",
"IncomingThroughputLimit" : 0,
"AsyncProcessing" : true,
"RecreateOnLogout" : true,
"AsyncProcessingQueueSizeLimit" : 0,
"SSL" : true,
"ConfiguredName" : "ConfiguredName",
"HBI" : 0,
"ExtraParams" : {
"SenderSubId" : "SenderSubId",
"ReconnectInterval" : 0,
"MessagesStorageSize" : "",
"DisableTCPBuffer" : true,
"SocketSendBufSize" : 0,
"SuppressDoubleResendRequest" : true,
"MaskedTags" : [ "MaskedTags", "MaskedTags" ],
"ResendRequestBlockSize" : 1,
"CyclicSwitchBackupConnection" : true,
"RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
"Validation" : {
"ProhibitUnknownTags" : false,
"AllowZeroNumInGroup" : true,
"IgnoreUnknownFields" : true,
"IsEnabled" : true,
"ProhibitDuplicatedTags" : true,
"CheckRequiredGroupFields" : true,
"ProhibitTagsWithoutValue" : true,
"VerifyTagsValues" : false,
"VerifyRepeatingGroupBounds" : false
},
"SendCpuAffinity" : 0,
"EncryptMethod" : "NONE",
"StorageType" : "StorageType",
"UserNameTag" : 0,
"CustomSessionType" : "CustomSessionType",
"LogIncomingMessages" : true,
"AggressiveReceiveDelay" : "",
"HandleSeqNumAtLogon" : true,
"SendLastMsgSeqNumProcessed" : true,
"SocketPriority" : "SocketPriority",
"SenderLocationID" : "SenderLocationID",
"LogonMessageSessionQualifierTag" : 0,
"KeepConnectionState" : true,
"SendingTimestampUnit" : "SendingTimestampUnit",
"Transport" : "Transport",
"SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
"ReconnectMaxTries" : 0,
"IgnoreSeqNumTooLowAtLogon" : true,
"ConnectPort" : 48874,
"ValidateCheckSum" : true,
"AllowMessageWithoutPossDupFlag" : true,
"ForcedReconnect" : true,
"SocketBusyPollTime" : 0,
"DeliverAppMessagesOutOfOrder" : true,
"TargetSubId" : "TargetSubId",
"TargetLocationID" : "TargetLocationID",
"PasswordTag" : 0,
"MaxMessagesAmountInBunch" : 0,
"FixKey" : "FixKey",
"GenerateCheckSum" : true,
"HiddenLogonCredentials" : true,
"Password" : "Password",
"UseBlockingSockets" : true,
"CpuAffinity" : 0,
"SocketRecvBufSize" : 0,
"EnableMessageRejecting" : true,
"StorageRecoveryStrategy" : "StorageRecoveryStrategy",
"UseAsyncConnect" : true,
"IntradayLogoutToleranceMode" : true,
"ConnectAddress" : "ConnectAddress",
"Username" : "Username",
"ForceSeqNumReset" : "NA",
"EnableAutoSwitchToBackupConnection" : true
},
"OutSeqNum" : 1,
"AppProtocolBaseVersion" : "AppProtocolBaseVersion",
"SSLCheckPrivateKey" : true,
"Qualifier" : "Qualifier",
"TerminateOnLogout" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionData
500
Session with the specified name does not exists
Up
get /sessions/sender/{sender}/target/{target}/statistics
Get single session's statistics (getSessionStatisticsById)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"ReceivedMessages" : 0,
"CurrentProcessingQueueSize" : 0,
"TargetCompID" : "TargetCompID",
"SentMessages" : 0,
"Qualifier" : "Qualifier",
"IncomingThroughput" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionStatistics
500
Cannot find the session with the specified ID
Up
get /sessions/{configuredName}/statistics
Get single session's statistics (getSessionStatisticsByName)
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"ReceivedMessages" : 0,
"CurrentProcessingQueueSize" : 0,
"TargetCompID" : "TargetCompID",
"SentMessages" : 0,
"Qualifier" : "Qualifier",
"IncomingThroughput" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionStatistics
400
Session with the specified name does not exists
Up
get /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/statistics
Get single session's statistics (getSessionStatisticsByQualifiedId)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"ReceivedMessages" : 0,
"CurrentProcessingQueueSize" : 0,
"TargetCompID" : "TargetCompID",
"SentMessages" : 0,
"Qualifier" : "Qualifier",
"IncomingThroughput" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionStatistics
500
Cannot find the session with the specified ID
Up
get /sessions/sender/{sender}/target/{target}/status
Get single session's status (getSessionStatusById)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"InSeqNum" : 1,
"OutSeqNum" : 1,
"SessionCreated" : true,
"AppProtocolBaseVersion" : "AppProtocolBaseVersion",
"TargetCompID" : "TargetCompID",
"Qualifier" : "Qualifier",
"ConfiguredName" : "ConfiguredName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionStatus
500
Cannot find the session with the specified ID
Up
get /sessions/{configuredName}/status
Get single session's status (getSessionStatusByName)
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"InSeqNum" : 1,
"OutSeqNum" : 1,
"SessionCreated" : true,
"AppProtocolBaseVersion" : "AppProtocolBaseVersion",
"TargetCompID" : "TargetCompID",
"Qualifier" : "Qualifier",
"ConfiguredName" : "ConfiguredName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionStatus
400
Session with the specified name does not exists
Up
get /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/status
Get single session's status (getSessionStatusByQualifiedId)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Return type
Example data
Content-Type: application/json
{
"SenderCompID" : "SenderCompID",
"InSeqNum" : 1,
"OutSeqNum" : 1,
"SessionCreated" : true,
"AppProtocolBaseVersion" : "AppProtocolBaseVersion",
"TargetCompID" : "TargetCompID",
"Qualifier" : "Qualifier",
"ConfiguredName" : "ConfiguredName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionStatus
500
Cannot find the session with the specified ID
Get list of TA and them sessions (listenDynamicState)
Query parameters
poll_period (optional)
Query Parameter — The period of polling the session parameters (which require polling) in ms.
By default - 1 second. default: 1000
log_level (optional)
Query Parameter — The level for log events. Valid values : none, warn.
By default - none. default: none
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Up
put /sessions/sender/{sender}/target/{target}
Modify existing session (modifySessionById)
Modifies new session with given sender and target. For detailed description of
remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request (e.g. mandatory parameters are missing)
404
Session does not exist
500
Failure to modify a session
Up
put /sessions/{configuredName}
Modify existing session (modifySessionByName)
Modifies new session with given ConfiguredName. For detailed description of
remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request (e.g. mandatory parameters are missing)
404
Session does not exist
500
Failure to modify a session
Up
put /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}
Modify existing session (modifySessionByQualifiedId)
Modifies new session with given sender, target and qualifier. For detailed description of
remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request (e.g. mandatory parameters are missing)
404
Session does not exist
500
Failure to modify a session
Up
post /sessions/{configuredName}/sequence-numbers/reset
Reset sequence numbers for the session. (resetSequenceNumbersOfSessionByName)
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Responses
200
OK
400
Bad request
500
Operation failed, e.g. session does not exist
Up
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/sequence-numbers/reset
Reset sequence numbers for the session. (resetSequenceNumbersOfSessionByQualifiedId)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Responses
200
OK
400
Bad request
500
Operation failed, e.g. session does not exist
Up
post /sessions/sender/{sender}/target/{target}/restart
Restart session (restartSessionById)
Restarts session with given sender, target and qualifier and resets
sequence numbers if requested.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Query parameters
seq_num_reset (optional)
Query Parameter — enables sequence number resetting default: null
in_seq_num (optional)
Query Parameter — sets specific inbound sequence number for session default: null
out_seq_num (optional)
Query Parameter — sets specific outbound sequence number for session default: null
Responses
200
OK
400
Bad request (e.g. mandatory parameters are missing)
500
Operation failed, e.g. session does not exist
Up
post /sessions/{configuredName}/restart
Restart session (restartSessionByName)
Restarts session with given sender, target and qualifier and resets
sequence numbers if requested.
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Query parameters
seq_num_reset (optional)
Query Parameter — enables sequence number resetting default: null
in_seq_num (optional)
Query Parameter — sets specific inbound sequence number for session default: null
out_seq_num (optional)
Query Parameter — sets specific outbound sequence number for session default: null
send_logout (required)
Query Parameter — perform nongraceful session termination if false default: null
logout_reason (required)
Query Parameter — logout reason description default: null
Responses
200
OK
400
Bad request (e.g. mandatory parameters are missing)
500
Operation failed, e.g. session does not exist
Up
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/restart
Restart session (restartSessionByQualifiedId)
Restarts session with given sender, target and qualifier and resets
sequence numbers if requested.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Query parameters
seq_num_reset (optional)
Query Parameter — enables sequence number resetting default: null
in_seq_num (optional)
Query Parameter — sets specific inbound sequence number for session default: null
out_seq_num (optional)
Query Parameter — sets specific outbound sequence number for session default: null
Responses
200
OK
400
Bad request (e.g. mandatory parameters are missing)
500
Operation failed, e.g. session does not exist
Up
post /sessions/sender/{sender}/target/{target}/output-messages
(sendMessageToSessionById)
Sends message to the session;s output channel.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request, e.g. body does not contain a JSON object
500
Operation failed, e.g. session does not exist
Up
post /sessions/{configuredName}/output-messages
(sendMessageToSessionByName)
Sends message to the session;s output channel.
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request, e.g. body does not contain a JSON object
500
Operation failed, e.g. session does not exist
Up
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/output-messages
(sendMessageToSessionByQualifiedId)
Sends message to the session's output channel.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request, e.g. body does not contain a JSON object
500
Operation failed, e.g. session does not exist
Up
get /sessions/metrics/{interval}
Poll all sessions' metrics (in and out sequence numbers) using interval (sessionsMetricsIntervalGet)
Path parameters
interval (required)
Path Parameter — default: null
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SessionStatusesEvent
Up
put /sessions/sender/{sender}/target/{target}/sequence-numbers
Modify input and/or output sequence numbers of the session. (setSequenceNumbersOfSessionById)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request, e.g. body does not contain a JSON object
500
Operation failed, e.g. session does not exist
Up
put /sessions/{configuredName}/sequence-numbers
Modify input and/or output sequence numbers of the session. (setSequenceNumbersOfSessionByName)
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request, e.g. body does not contain a JSON object
500
Operation failed, e.g. session does not exist
Up
put /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/sequence-numbers
Modify input and/or output sequence numbers of the session. (setSequenceNumbersOfSessionByQualifiedId)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK
400
Bad request, e.g. body does not contain a JSON object
500
Operation failed, e.g. session does not exist
Up
post /sessions/sender/{sender}/target/{target}/started
(startSessionById)
Starts session identified by given sender-target.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Query parameters
seq_num_reset (optional)
Query Parameter — enables sequence number resetting default: null
Responses
200
OK
500
Operation failed, e.g. session does not exist
Up
post /sessions/{configuredName}/started
(startSessionByName)
Starts session identified by given session name.
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Query parameters
seq_num_reset (optional)
Query Parameter — enables sequence number resetting default: null
Responses
200
OK
500
Operation failed, e.g. session does not exist
Up
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/started
(startSessionByQualifiedId)
Starts session identified by given sender-target-qualifier.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Responses
200
OK
500
Operation failed, e.g. session does not exist
Up
delete /sessions/sender/{sender}/target/{target}/started
(stopSessionById)
Stops session identified by given sender-target.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Query parameters
send_logout (required)
Query Parameter — perform nongraceful session termination if false default: null
logout_reason (required)
Query Parameter — logout reason description default: null
Responses
200
OK
500
Operation failed, e.g. session does not exist
Up
delete /sessions/{configuredName}/started
(stopSessionByName)
Stops session identified by given session name.
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Query parameters
send_logout (required)
Query Parameter — perform nongraceful session termination if false default: null
logout_reason (required)
Query Parameter — logout reason description default: null
Responses
200
OK
500
Operation failed, e.g. session does not exist
Up
delete /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/started
(stopSessionByQualifiedId)
Stops session identified by given sender-target-qualifier.
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Query parameters
send_logout (required)
Query Parameter — perform nongraceful session termination if false default: null
logout_reason (required)
Query Parameter — logout reason description default: null
Responses
200
OK
500
Operation failed, e.g. session does not exist
Up
post /sessions/sender/{sender}/target/{target}/connection/backup
Switch session to backup connection (switchConnectionToBackupById)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Responses
200
OK (switch has been successful or specified session already uses backup connection)
400
Session with such sessionId has not been found
500
Operation failed (e.g. applied to acceptor session or initiator session is missing backup properties)
Up
post /sessions/{configuredName}/connection/backup
Switch session to backup connection (switchConnectionToBackupByName)
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Responses
200
OK (switch has been successful or specified session already uses backup connection)
400
Session with such sessionId has not been found
500
Operation failed (e.g. applied to acceptor session or initiator session is missing backup properties)
Up
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/connection/backup
Switch session to backup connection (switchConnectionToBackupByQualifiedId)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Responses
200
OK (switch has been successful or specified session already uses backup connection)
400
Session with such sessionId has not been found
500
Operation failed (e.g. applied to acceptor session or initiator session is missing backup properties)
Up
post /sessions/sender/{sender}/target/{target}/connection/primary
Switch session to primary connection (switchConnectionToPrimaryById)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
Responses
200
OK (switch has been successful or specified session already uses primary connection)
400
Session with such sessionId has not been found
500
Operation failed (e.g. applied to acceptor session)
Up
post /sessions/{configuredName}/connection/primary
Switch session to primary connection (switchConnectionToPrimaryByName)
Path parameters
configuredName (required)
Path Parameter — name of the session specified by ConfiguredName property during session creation default: null
Responses
200
OK (switch has been successful or specified session already uses primary connection)
400
Session with such sessionId has not been found
500
Operation failed (e.g. applied to acceptor session)
Up
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/connection/primary
Switch session to primary connection (switchConnectionToPrimaryByQualifiedId)
Path parameters
sender (required)
Path Parameter — identifier of session sender side default: null
target (required)
Path Parameter — identifier of session target side default: null
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers default: null
Responses
200
OK (switch has been successful or specified session already uses primary connection)
400
Session with such sessionId has not been found
500
Operation failed (e.g. applied to acceptor session)
[ Jump to Methods ]
Table of Contents
AdaptorDynamicState - AdaptorPollableDynamicState - AdaptorSessionDynamicState - AdaptorSessionPollableDynamicState - AdaptorsDynamicStateEvent - AdaptorsPollableDynamicStateEvent - BLError - LogEvent - MonitoringEvent - MonitoringEventType - NamedScheduleConfig - QueueItem - QueueStatus - RemovedQueueItem - ScheduleConfig - SessionActiveConnection - Active connection to useSessionBackupParameters - SessionData - SessionExtraParameters - SessionParams - SessionRole - Role of a sessionSessionSequenceNumbers - SessionState - State of a sessionSessionStatistics - SessionStatus - SessionStatusesEvent - SessionUpdatableParams - SessionsDataEvent - StatusGroup - UnderlyingProtocol - ValidationParameters -
AdaptorName (optional)
Sessions (optional)
AdaptorName (optional)
Sessions (optional)
SessionId (optional)
StatusGroup (optional)
component (optional)
error (optional)
level (optional)
WARN
ERROR
logger (optional)
message (optional)
StartTime (optional)
ConnectTime (optional)
DisconnectTime (optional)
TerminateTime (optional)
DaysOff (optional)
TimeZone (optional)
MessageId (optional)
MessageType (optional)
ClientID (optional)
ClOrdID (optional)
MessageText (optional)
EnqueuedTimestamp (optional)
QueueName (optional)
ScheduleName (optional)
TargetSession (optional)
QueuedMessages (optional)
IsProcessing (optional)
OnHold (optional)
MessageId (optional)
IsRemoved (optional)
StartTime (optional)
ConnectTime (optional)
DisconnectTime (optional)
TerminateTime (optional)
DaysOff (optional)
TimeZone (optional)
HBI (optional)
Integer Heartbeat invterval (in seconds). Only required for initiator sessions
RemoteHost (optional)
String Only required for initiator sessions
RemotePort (optional)
Integer Only required for initiator sessions
ExtraSessionParams (optional)
ConfiguredName (optional)
Role (optional)
State (optional)
SenderCompID (optional)
TargetCompID (optional)
Qualifier (optional)
AppProtocolBaseVersion (optional)
Protocol (optional)
HBI (optional)
Integer Heartbeat interval (in seconds)
RemotePort (optional)
InSeqNum (optional)
OutSeqNum (optional)
RecreateOnLogout (optional)
TerminateOnLogout (optional)
StorageType (optional)
ActiveConnection (optional)
SSL (optional)
SSLCheckPrivateKey (optional)
IncomingMessagesLimit (optional)
OutgoingQueueSizeLimit (optional)
IncomingThroughputLimit (optional)
AsyncProcessing (optional)
AsyncProcessingQueueSizeLimit (optional)
ExtraParams (optional)
SenderSubId (optional)
TargetSubId (optional)
SenderLocationID (optional)
TargetLocationID (optional)
Username (optional)
Password (optional)
UserNameTag (optional)
HiddenLogonCredentials (optional)
FixKey (optional)
CustomSessionType (optional)
SendingTimestampUnit (optional)
PasswordTag (optional)
MaskedTags (optional)
SourceIPaddress (optional)
IntradayLogoutToleranceMode (optional)
true
false
null
ForceSeqNumReset (optional)
NA
false
true
ALWAYS
true
false
EncryptMethod (optional)
NONE
ForcedReconnect (optional)
true
false
null
EnableMessageRejecting (optional)
Boolean Reject messages if server is unable to send them in a specified time period or disconnected
true
false
null
IgnoreSeqNumTooLowAtLogon (optional)
Boolean Ignore SeqNum too low message and continue with the specified SeqNum
true
false
null
KeepConnectionState (optional)
true
false
null
UseAsyncConnect (optional)
true
false
null
DisableTCPBuffer (optional)
Boolean true - TCP buffer (Nagle algorithm) will be disabled for the session
true
false
null
SocketRecvBufSize (optional)
SocketSendBufSize (optional)
SocketBusyPollTime (optional)
StorageType (optional)
StorageRecoveryStrategy (optional)
MaxMessagesAmountInBunch (optional)
SocketPriority (optional)
AggressiveReceiveDelay (optional)
Object This property must be either an non-negative integer or
null.
EnableAutoSwitchToBackupConnection (optional)
Boolean true - enabled automatic mode switch. Default: false
true
false
null
CyclicSwitchBackupConnection (optional)
Boolean Enable connection probing loop between primary and backup connections until connection will be established.
true
false
null
HandleSeqNumAtLogon (optional)
Boolean Handle sequence gaps using NextExpectedMsgSeqNum.
true
false
null
ReconnectMaxTries (optional)
ReconnectInterval (optional)
ConnectAddress (optional)
ConnectPort (optional)
MessagesStorageSize (optional)
Object This property must be either an non-negative integer or
null.
AllowMessageWithoutPossDupFlag (optional)
Boolean true - Message with low SeqNum and without PossDupFlag(43) will trigger the connection close. false - message will be processed.
true
false
null
SuppressDoubleResendRequest (optional)
Boolean Suppress ResendRequest on every incoming message when SeqNum is too high
true
false
bool
DeliverAppMessagesOutOfOrder (optional)
Boolean Forces session to deliver messages if SeqNum is too high. Requested by CME.
true
false
null
SendLastMsgSeqNumProcessed (optional)
true
false
null
ValidateCheckSum (optional)
true
false
null
GenerateCheckSum (optional)
true
false
null
LogIncomingMessages (optional)
true
false
null
ResendRequestBlockSize (optional)
Transport (optional)
UseBlockingSockets (optional)
true
false
null
CpuAffinity (optional)
SendCpuAffinity (optional)
LogonMessageSessionQualifierTag (optional)
RawDataTagProcessingStrategies (optional)
Validation (optional)
ActiveConnection (optional)
Backup (optional)
ConfiguredName (optional)
ConnectTime (optional)
DisconnectTime (optional)
ExtraParams (optional)
HBI (optional)
InSeqNum (optional)
OutSeqNUm (optional)
RecreateOnLogout (optional)
RemoteHost (optional)
RemotePort (optional)
Schedule (optional)
StartTime (optional)
StorageType (optional)
TerminateOnLogout (optional)
TerminateTime (optional)
InSeqNum (optional)
OutSeqNum (optional)
Possible states of Session.
- ESTABLISHED - The session is fully established
- INITIAL - The session has been created, but has not been connected yet
- NON_GRACEFULLY_TERMINATED - The session has been non-gracefully terminated
- RECONNECT - The session-initiator has detected the telecommunication link error and is trying to re-establish the link
- CORRECTLY_TERMINATED - The session has been correctly terminated
- WAIT_FOR_CONFIRM_LOGON - The session has been connected as an Initiator, the first Logon message has been sent and it is waiting for the conforming Logon message
- WAIT_FOR_CONFIRM_LOGOUT - Waiting for confirm logout state
- WAIT_FOR_FIRST_LOGON - The session has been connected as an Acceptor and is waiting for the first Logon message
- SWITCH_CONNECTION - The session switch to the another connection (backup or primary)
- WAIT_FOR_FIRST_HELLO - The session has been connected as an Acceptor and is waiting for the first Hello message
- WAIT_FOR_CONFIRM_HELLO - The session has been connected as an Initiator, the first FAST Hello message has been sent and it is waiting for the conforming Hello message
- WAIT_FOR_CONNECT - The session-initiator is waiting fo async connect to complete
SenderCompID (optional)
TargetCompID (optional)
Qualifier (optional)
ReceivedMessages (optional)
SentMessages (optional)
IncomingThroughput (optional)
CurrentProcessingQueueSize (optional)
ConfiguredName (optional)
SenderCompID (optional)
TargetCompID (optional)
Qualifier (optional)
AppProtocolBaseVersion (optional)
Status (optional)
ActiveConnection (optional)
InSeqNum (optional)
OutSeqNum (optional)
SessionCreated (optional)
ActiveConnection (optional)
Backup (optional)
ConfiguredName (optional)
ConnectTime (optional)
DisconnectTime (optional)
ExtraParams (optional)
HBI (optional)
InSeqNum (optional)
OutSeqNUm (optional)
RecreateOnLogout (optional)
RemoteHost (optional)
RemotePort (optional)
Schedule (optional)
StartTime (optional)
StorageType (optional)
TerminateOnLogout (optional)
TerminateTime (optional)
event
String Event type (get, create, change state, delete)
data
Set of the supported underlying protocols
IsEnabled (optional)
true
false
null
ProhibitTagsWithoutValue (optional)
Boolean false: Messages empty tags will be ignored. Otherwise exception will be thrown
true
false
null
VerifyTagsValues (optional)
Boolean false: Counterparty validates the messages by itself
true
false
null
ProhibitUnknownTags (optional)
Boolean false: The engine will reject messages with unknown fields. true: The engine will store the message as it is.
true
false
null
VerifyRepeatingGroupBounds (optional)
Boolean true: The check is performed by server. false: Message will be passed to the application layer as is and the counterparty is responsible for its validity.
true
false
null
CheckRequiredGroupFields (optional)
Boolean true: The check is performed by server. false: The check is performed by counterparty.
true
false
null
AllowZeroNumInGroup (optional)
Boolean true: accept. false: reject
true
false
null
ProhibitDuplicatedTags (optional)
Boolean true: Reject messages with duplicated field definitions. false: Accept such messages
true
false
null
IgnoreUnknownFields (optional)
true
false
null