Schema: MsgDesc (ID: 3415)

METADATA

Attribute	Value
Topic	3325-mlink
MLink Token	MLinkRest

Note: The symbol = next to a field number indicates that it is a primary key.

BODY

#	Field	Type	Comment
100	name	string(48)	message name
103	mNum	ushort	protobuf message number
106	schemaHash	string(16)	schema hash (changes each time the schema is modified)
144	actions	flag : MLinkActions	'SIURD'
112	hasTKey	enum : YesNo	message contains a 'TickerKey' x-ray field
115	hasEKey	enum : YesNo	message contains an 'ExpiryKey' x-ray field
118	hasOKey	enum : YesNo	message contains an 'OptionKey' x-ray field
121	hasCF	enum : YesNo	message has a 'ClientFirm' fields (message has client firm visiblity restrictions)
124	mToken	enum : MLinkToken	the mlink token this message is associated with
145	dataProducts	flag : DataProduct	flag enum containing all the data products this message is associated with
140	srseProducts	text1	comma separated list of the SRSE Products this message is associated with
127	desc	text2	message description (if any)
146	topic	string(48)	message topic
147	autoAssignedPkey	enum : YesNo	indication that MLink adds its own pkey and the user does not need to specify one.
130	priTimeField	string(32)	this is the primary time field for the time control and histogram
133	secTimeField	string(32)	this is the Top10 field for the stacked bar / label on the time control histogram (blank if none)
139	staticFilterFields	text2	comma separated list of (default) static filter fields (in display order)

REPEATING FIELDS

GridFieldOptions

Field	Type	Comment
142	name	string(64)
143	fields	string(255)

Get Schema API Call

Python

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'MsgDesc'

# Request Parameters for Get Schema Of The MsgType
params = {
#Required Parameters
"apiKey": API_KEY,
"cmd": 'getschema',
"msgType": MSG_TYPE, 
}

response = requests.get(MLINK_PROD_URL, params=params)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getschema' \
--data-urlencode 'msgType=MsgDesc'

Get Msg API Call

Python

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'MsgDesc'

# Replace with your pkey value for getting the specific message desired
PKEY = 'ReplaceThisValueForTheQueryToWork'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned. 
VIEW = 'name|mNum|schemaHash|actions|hasTKey|hasEKey|hasOKey|hasCF|mToken|dataProducts|srseProducts|desc|topic|autoAssignedPkey|priTimeField|secTimeField|staticFilterFields'

# Replace with your desired where clause.
# a string in the form "field1:eq:valuse" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = 'name:eq:ExampleString'

# Request Parameters for getmsg Of The MsgType
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'getmsg',
    "pkey": PKEY,
    "msgType": MSG_TYPE,
    # Optional Parameters
    "view": VIEW, 
    "where": WHERE
}

response = requests.get(MLINK_PROD_URL, params=params)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getmsg' \
--data-urlencode 'pkey=ReplaceThisValueForTheQueryToWork' \
--data-urlencode 'msgType=MsgDesc' \
--data-urlencode 'view=name|mNum|schemaHash|actions|hasTKey|hasEKey|hasOKey|hasCF|mToken|dataProducts|srseProducts|desc|topic|autoAssignedPkey|priTimeField|secTimeField|staticFilterFields' \
--data-urlencode 'where=name:eq:ExampleString'

Get Msgs API Call

Python

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'MsgDesc'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'name|mNum|schemaHash|actions|hasTKey|hasEKey|hasOKey|hasCF|mToken|dataProducts|srseProducts|desc|topic|autoAssignedPkey|priTimeField|secTimeField|staticFilterFields'

# Replace with your desired where clause.
# a string in the form "field1:eq:value" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = 'name:eq:ExampleString'

# Replace with your desired limit of how many messages you receive. The default limit is 500
LIMIT = 500

# Order clause eg. "(field1:DESC | field1:ASC | field2:DESC:ABS | field2:ASC:ABS" (default is unordered; default is faster)
ORDER = 'name:ASC'

# Request Parameters for getmsgs Of The MsgType
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'getmsgs',
    "msgType": MSG_TYPE,
    # Optional Parameters
    "view": VIEW, 
    "where": WHERE,
    "limit": LIMIT,
    "order": ORDER
}

response = requests.get(MLINK_PROD_URL, params=params)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getmsgs' \
--data-urlencode 'msgType=MsgDesc' \
--data-urlencode 'view=name|mNum|schemaHash|actions|hasTKey|hasEKey|hasOKey|hasCF|mToken|dataProducts|srseProducts|desc|topic|autoAssignedPkey|priTimeField|secTimeField|staticFilterFields' \
--data-urlencode 'where=name:eq:ExampleString' \
--data-urlencode 'limit=500' \
--data-urlencode 'order=name:ASC'

Get Aggregate API Call

Python

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'MsgDesc'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'name|mNum|schemaHash|actions|hasTKey|hasEKey|hasOKey|hasCF|mToken|dataProducts|srseProducts|desc|topic|autoAssignedPkey|priTimeField|secTimeField|staticFilterFields'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'hasTKey|hasEKey|hasOKey|hasCF|mToken|autoAssignedPkey'

# Replace with your desired where clause.
# a string in the form "field1:eq:value" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = 'name:eq:ExampleString'

# Request Parameters for getaggregate Of The MsgType
params = {
# Required Parameters
"apiKey": API_KEY,
"cmd": 'getaggregate',
"msgType": MSG_TYPE,
"measure": MEASURE,
"group": GROUP,
# Optional Parameters
"where": WHERE,
}

response = requests.get(MLINK_PROD_URL, params=params)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getaggregate' \
--data-urlencode 'msgType=MsgDesc' \
--data-urlencode 'measure=name|mNum|schemaHash|actions|hasTKey|hasEKey|hasOKey|hasCF|mToken|dataProducts|srseProducts|desc|topic|autoAssignedPkey|priTimeField|secTimeField|staticFilterFields' \
--data-urlencode 'group=hasTKey|hasEKey|hasOKey|hasCF|mToken|autoAssignedPkey' \
--data-urlencode 'where=name:eq:ExampleString'

Get Count API Call

Python

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'MsgDesc'

# Replace with your desired where clause.
# a string in the form "field1:eq:value" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = 'name:eq:ExampleString'

# Request Parameters for getCount Of The MsgType
params = {
# Required Parameters
"apiKey": API_KEY,
"cmd": 'getcount',
"msgType": MSG_TYPE,
# Optional Parameters
"where": WHERE,
}

response = requests.get(MLINK_PROD_URL, params=params)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getcount' \
--data-urlencode 'msgType=MsgDesc' \
--data-urlencode 'where=name:eq:ExampleString'