...
Name | Description | Sample Values |
action | String indicating the action to be executed. RUN_REPORT is the default action value for running eMACH-Sigma reports. String indicating the action to be executed. EXEC_REPORT_GROUP is the default action value for generating group reports.
| RUN_REPORT, EXEC_REPORT_GROUP |
reportId | | Note |
|---|
When accessing the reports, the Report ID is mandatory, while the Group Report ID is optional. |
| Note |
|---|
To access the report groups, a Group Report ID is mandatory. |
| |
accessToken | Indicates the access token. | sample61d74837-2e77-4ede-a967-2c84b30-dws-b3b4f 7 |
reportFilter | If filterId is Number or String datatype: For Contains operator use STR_CONTAINS For in operator use STR_IN For Equals operator use STR_EQUALS
If filterId is Date datatype: For Equals Timestamp operator use TDT_EQUALS For Equals operator use TDT_EQUALS_DATE For Financial Year operator use TDT_FINANCIAL_YEAR For Financial Year (w) Quarter operator use TDT_FINANCIAL_YEAR_QUARTER For Greater than operator use TDT_GT For Greater than or Equal to operatoruse TDT_GTEQUALTO For Less than operator use TDT_LT For Less than or Equal to operator use TDT_LTEQUALTO For From operator use TDT_RANGE For Relative Range operator use TDT_RELATIVE_RANGE For YTD operator use TDT_YTD
If filterId is Long datatype: For < operator use NUM_LONG_LT For <= operator use NUM_LONG_LTEQUALTO For != operator use NUM_LONG_NOTEQUALTO For = operator use NUM_LONG_EQUALS For > operator use NUM_LONG_GT For >= operator use NUM_LONG_GTEQUALTO
| | Code Block |
|---|
"reportFilter" : {
"preHookParams":{"NAME":["SIGMA"]},"procedureParams":{"NAME":["SIGMA"]},"additionalParams":{"ADD_INP":["DEMO1"]}, "bindParams":{"NAME":["DEMO1"]}, "filterDef": [{"columnId": "ACCOUNT_TYPE", "filterId": "STR_CONTAINS","filterDataType": "string" ,"filterValues": "savings","filterDescriptions":"savings"}]
} |
|
...
Parameter | Type | Description |
replyType | string | For reply type, the report status will be returned as 'SUCCESS' if the running individual report is successful or 'FAILURE' if the report is a failure. |
reportId | string | Generated reports IDs. |
referenceNumber | sting | A unique reference number provided for downloading reports. |
statusCode | int | Code for report status. The response error details for each HTTP code are as follows:
200 - Success
204 - Request is successful but the requested data is not available.
400 - Request syntax is incorrect or the parameters supplied were invalid.
401 - Unauthorized API.
500 - Server encountered an unexpected condition, which prevented it from fulfilling the request. |
Sample Response for Group Report ID
| Code Block |
|---|
{
"headerMap": {
"replyType": "SUCCESS",
"success": "true",
"reportGroupStatus": {
"referenceNumber": " sample2djj-6c394d0e-9802-49ae-bdd3-9ccaed431ecd ",
"reportGroupId": " AccountTransaction ",
"statusCode": 200,
"status": "SUCCESS"
}
}
} |
Sample Response for Report ID
| Code Block |
|---|
{
"headerMap": {
"replyType": "SUCCESS",
"reportId": " samplejk34-0925bccf-29f0-42f2-8896-77c57aea2198",
"referenceNumber": " sample2djj-6c394d0e-9802-49ae-bdd3-9ccaed431ecd ",
"success": "true",
"statusCode": 200,
"status": "SUCCESS"
}
} |
|
...