...
The Input Parameter column is the predefined tag for the request payload in JSON format.
The Mandatory column refers to if the parameter is required to give in the request payload or not.
The POST and GET method columns refers to if the respective request payload is supported or not.
The Example column contains examples of the request payload.
# | Input Parameter | Mandatory | POST | GET | Example |
1 | reportName | Yes | Yes | Yes | "reportName": "SK Cash Balance Report", |
2 | entityID | Yes | Yes | Yes | "entityId": "SUBFICSH", |
3 | beginDate | Yes | Yes | Yes | "beginDate": "20140531", |
4 | endDate | Yes | Yes | Yes | "endDate": "20140601", |
5 | fields | No | Yes | Yes | "fields": "1781,1196,3255", |
6 | outputFormat | No | Yes | Yes | "outputFormat": "JSON2", |
7 | constituentsAndBenchmarkToComposite | No | Yes | Yes | "constituentsAndBenchmarkToComposite" |
8 | benchmarkToPortfolio | No | Yes | Yes | "benchmarkToPortfolio": true, |
9 | firstAlternateCurrency | No | Yes | Yes | "firstAlternateCurrency": "CAD", |
10 | secondAlternateCurrrency | No | Yes | Yes | "secondAlternateCurrrency": "INR", |
11 | fetchPriorFXRates | No | Yes | Yes | "fetchPriorFXRates": "7", |
12 | "benchmarkOverride": | No Yes No | "benchmarkOverride": | ||
{ | { | ||||
"<benchmarkDefinition>":"<Entity | "Primary Comparison Index":"MTHREN3", | ||||
"<benchmarkDefinition>":"<Entity | "Comparison Index 5": "MTHREN9", | ||||
"IsEntities": true | "IsEntities": true | ||||
} | } | ||||
13 | "benchmarkOverride": | No Yes No | "benchmarkOverride": | ||
{ | { | ||||
"<benchmarkDefinition>":<benchmarkDefinition>", | "Market Portfolio":"Primary Comparison Index", | ||||
"IsEntities": false | "Comparison Index 5": "Comparison Index 4", | ||||
} | "IsEntities": false | ||||
_ | _ _ _ | } | |||
14 | groupingRuleOverride: { | No | Yes | No | groupingRuleOverride: { |
"groupModel": [{"simple": "fieldID"}, | "groupModel": [{"simple": "1061"},{"range": "8178"},{"perfModel": "178"}], | ||||
"calculationAndDisplay": { | "calculationAndDisplay": { | ||||
"calculateAttributionAndDisplay": | "calculateAttributionAndDisplay": "1060", | ||||
"limitResultToLevelAbove": "DoNotLimit | "limitResultToLevelAbove": "LimitFetchDisplay", | ||||
"showBelowAttribution": "true/false", | "showBelowAttribution": "true", | ||||
"hideBenchmarkOnlySecurities": "true/false" | "hideBenchmarkOnlySecurities": "true" | ||||
}, | }, | ||||
"dynamicPerformance": { | "dynamicPerformance": { | ||||
"portfolioLookThrough": true/false, | "portfolioLookThrough": true, | ||||
"adjustSecurityToMatchParent": true/false, | "adjustSecurityToMatchParent": true, | ||||
"applyFilterToBenchmark": true/false | "applyFilterToBenchmark": true | ||||
}, | }, | ||||
"entityHierarchy":"BOTTOMUPBALANCED | "entityHierarchy":"BOTTOMUPBALANCED", | ||||
"globalAttributionOptions": "Single-globalattributionFieldID" | "globalAttributionOptions": "14533" | ||||
} | } | ||||
15 | report rule | No | Yes | Yes | "reportRuleId":"3588" |
16 | fieldRule | No | Yes | Yes | "fieldRuleId":"3088" |