Running Group Reports

This API returns a unique Reference Number that can be used as a payload for checking report status and downloading group reports.

Resource URL
POST Method Resource URL: http://localhost:9081/sigma/rest/reports/generate

Query Parameters are as follows:

Name	Description	Sample Values
action	String indicating the action to be executed. EXEC_REPORT_GROUP is the default action value for generating group reports.	EXEC_REPORT_GROUP
reportGroupId	Group Report ID.	AccountTransaction
accessToken	Indicates the access token.	sample61d74837-2e77-4ede-a967-2c84b30-dws-b3b4f

Response Parameters are as follows:

Parameter	Type	Description
replyType	string	For reply type, the report status will be returned as 'SUCCESS' if the running group report is successful or 'FAILURE' if the groupreport is a failure.
reportGroupId	string	Generating reports ID.
referenceNumber	sting	A unique reference number provided for downloading group 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

{
"headerMap": {
"replyType": "SUCCESS",
"success": "true",
"reportGroupStatus": {
"referenceNumber": " sample2djj-6c394d0e-9802-49ae-bdd3-9ccaed431ecd ",
"reportGroupId": " AccountTransaction ",
"statusCode": 200,
"status": "SUCCESS"
}
}
}