7.1.1 Request JSON Parameters

Table 7-2 Request JSON Parameters

Name Type Required Description
SummaryPayload OBJECT Yes This is an object with the properties mentioned below
objectid STRING Yes

Specify an unique string identifier for the execution. Allowed characters are alphabets , numbers, Hyphen(-),and Underscore(_)

No other special characters are allowed

For example: 'test123'

processID STRING Yes Process ID of the Run Pipeline
objecttype STRING NO Specify an empty string
locale STRING Yes Specify values as 'en-us'
applicationparams OBJECT Yes Specify values for the run time execution parameters.

Request JSON Samples

You can additionally pass Hierarchy Name or description with the code though it's not mandatory.

{  
"SummaryPayload": {
    "objectid": "$objectId",
    "processID": "1652966081449",
    "objecttype": "null",    
    "locale": "en-US",
    "applicationparams":{"FIC_MIS_DATE":"2020-06-01"}
  }
}
{  
"SummaryPayload": {
    "objectid": "$objectId",
    "processID": "1652966081449",
    "objecttype": "null",    
    "locale": "en-US",
    "applicationparams":{"FIC_MIS_DATE":"2019-12-27",
               "DATA_SOURCE":"0","LE":"1","LEDGER_ID":"13",
              "V_RUN_MAIN_DESC":"DRY_RUN"}
  }
}
{  
"SummaryPayload": {
    "objectid": "$objectId",
    "processID": "1652966081449",
    "objecttype": "null",    
    "locale": "en-US",
    "applicationparams":{"FIC_MIS_DATE":"2020-01-03","hierDetailsDATA_SOURCE":[{"hierValueCode":"19","value":"Swaps","hierNodeCode":"91BCE0029346911993",
                     "leafCondition":"CASE WHEN DIM_DATA_SOURCE.F_LATEST_RECORD_INDICATOR = 'Y' THEN DIM_DATA_SOURCE.N_DATA_SOURCE_ID END = '19'","hierNodeDesc":"Swaps"}],
              "hierDetailsLE":[{"hierValueCode":"1","value":"MYBANK_US_01","hierNodeCode":"91BCE003934691193",
                        "leafCondition":"CASE WHEN DIM_LEGAL_ENTITY.F_LATEST_RECORD_INDICATOR = 'Y' THEN DIM_LEGAL_ENTITY.N_LE_ID END = '1'",
                 "hierNodeDesc":"MYBANK_US_01"}],"V_RUN_MAIN_DESC":"21-SWAPS-1-20200102","LEDGER_ID":"123457000000000"}
  }
}