Skip to main content
Version: 8.6.9.2

Schema: ClientConfigChangeRequest (ID: 1935)

One request carries a SERIES of record-level operations (target message + pkey +

the changed fields + their propose-time values) that merge, reject, or return

as one unit. crClass discriminates the two review queues: Settings reviews

ClientConfig requests, Risk Controls reviews RiskControl requests.

Merged and Rejected are TERMINAL - no further transitions or withdraws; a new

request is required. Pending/Returned remain actionable. Note comments stay

accepted on terminal records - terminal seals the DECISION, not the conversation

(every publish is archived; the 24h retention window bounds the append period).

Merge is apply-FIRST and SERVER-SIDE: a decide to Merged runs the ops through the

target messages' own write pipelines under the CHECKER'S session (per-record ACL

re-checks as if the checker posted each write); ONLY on total success does the

state commit to Merged. On any failure the state stays as it was and the failure

is recorded as a durable mergeFail comment (failedCount).

RiskControl requests carry exactly ONE op (no baskets).

METADATA​

AttributeValue
Topic1800-client-config
MLink TokenClientControl
MLink EndpointMLink-Live

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

BODY​

#FieldTypeDefault ValueComment
10=clientFirmstring(16)scoping firm - the ACL boundary
13=crIdstring(32)"CR-000123"; minted by the proposing server; unique within clientFirm
100crClassenum : CRClassreview-queue discriminator
103crStateenum : CRStateMerged/Rejected terminal; Pending/Returned actionable
106opSummarytext1server-derived from the ops: unique target message names (Account* family collapses to AccountConfig)
109opCountintops in edits, so a grid never parses the JSON
112targetMsgstring(48)PRIMARY target message name, for grouping/filtering
115targetKeytext1human-readable primary pkey ("SPON1 / CORE / Firm")
116isTestChangeenum : YesNoderived at propose: Yes = any test op (pkey isTestAccnt=Yes or Account*-family accnt 'T*'); No = env-carrying ops all prod; None = no op carries an env marker (env-less config - both books)
118editstext2JSON {v, ops:[{n, op:replace
121editsHashstring(64)hash of edits at propose time - tamper/replay check on approve
124requestedBystring(24)
127requestedDttmDateTime
130reviewedBystring(24)empty while Pending; compared to requestedBy for the apply-own gate
133reviewedDttmDateTime
136appliedDttmDateTimewhen the merged ops actually committed (apply-first: stamped with the Merged decide)
139commentstext2JSON {v, log:[{id, by, at, kind:note
140commentCountintlog entries in comments, so a grid never parses the JSON
141failedCountintmergeFail entries in comments - a failed merge leaves crState unchanged but stamps this
142modifiedBystring(24)
145modifiedInenum : SysEnvironment
148timestampDateTime

Get Schema API Call​

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 = 'ClientConfigChangeRequest'

# 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)

Get Msg API Call​

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 = 'ClientConfigChangeRequest'

# 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 = 'crClass|crState|opSummary|opCount|targetMsg|targetKey|isTestChange|edits|editsHash|requestedBy|requestedDttm|reviewedBy|reviewedDttm|appliedDttm|comments|commentCount|failedCount|modifiedBy|modifiedIn|timestamp'

# 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 = 'clientFirm: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)

Get Msgs API Call​

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 = 'ClientConfigChangeRequest'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'crClass|crState|opSummary|opCount|targetMsg|targetKey|isTestChange|edits|editsHash|requestedBy|requestedDttm|reviewedBy|reviewedDttm|appliedDttm|comments|commentCount|failedCount|modifiedBy|modifiedIn|timestamp'

# 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 = 'clientFirm: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 = 'crClass: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)

Get Aggregate API Call​

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 = 'ClientConfigChangeRequest'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'crClass|crState|opSummary|opCount|targetMsg|targetKey|isTestChange|edits|editsHash|requestedBy|requestedDttm|reviewedBy|reviewedDttm|appliedDttm|comments|commentCount|failedCount|modifiedBy|modifiedIn|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'crClass|crState|isTestChange|modifiedIn'

# 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 = 'clientFirm: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)

Get Count API Call​

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 = 'ClientConfigChangeRequest'

# 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 = 'clientFirm: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)

Post Msgs API Call​

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'

# Request Parameters
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'postmsgs',
    "postaction": "I", # (I)nsert, (U)pdate, (R)eplace, or (D)elete
    "postmerge": "Y", # (Y)es or (N)o
}

payload = {
    "header": {
        "mTyp": "ClientConfigChangeRequest"
    },
    "message": {
        "pkey": {
            "clientFirm": "exampleString", // string
            "crId": "exampleString" // string
        },
        "crClass": "enumValue", // enum(CRClass) - None, ClientConfig, RiskControl
        "crState": "enumValue", // enum(CRState) - None, Pending, Merged, Rejected, Returned
        "opSummary": "exampleString", // text1
        "opCount": 1, // int
        "targetMsg": "exampleString", // string
        "targetKey": "exampleString", // text1
        "isTestChange": "enumValue", // enum(YesNo) - None, Yes, No
        "edits": "exampleString", // text2
        "editsHash": "exampleString", // string
        "requestedBy": "exampleString", // string
        "requestedDttm": "2025-01-01 12:00:00.000000", // yyyy-MM-dd HH:mm:ss.SSSSSS
        "reviewedBy": "exampleString", // string
        "reviewedDttm": "2025-01-01 12:00:00.000000", // yyyy-MM-dd HH:mm:ss.SSSSSS
        "appliedDttm": "2025-01-01 12:00:00.000000", // yyyy-MM-dd HH:mm:ss.SSSSSS
        "comments": "exampleString", // text2
        "commentCount": 1, // int
        "failedCount": 1, // int
        "modifiedBy": "exampleString", // string
        "modifiedIn": "enumValue", // enum(SysEnvironment) - None, Neptune, Pluto, V7_Stable, V7_Latest, Saturn, Venus, Mars, SysTest, V7_Current
        "timestamp": "2025-01-01 12:00:00.000000" // yyyy-MM-dd HH:mm:ss.SSSSSS
    }
}

response = requests.post(MLINK_PROD_URL, params=params, json=payload)
Table of Contents