Checking Group Report Status

This API returns the status of group report generation.

Resource URL
POST Method Resource URL: http://localhost:9081/sigma/rest/reports/report-status

Query Parameters are as follows:

Name	Description	Sample Values
action	String indicating the action to be executed. REPORT_GROUP_INSTANCE_STATUS_CHECK is the default action value for checking status for group reports.	REPORT_GROUP_INSTANCE_STATUS_CHECK
referenceNumber	Unique number provided as the response for running group reports API request.	sample2djj-6c394d0e-9802-49ae-bdd3-9ccaed431ecd
accessToken	Obtained access token as the response for generate token API request.	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 group reports status checking is successful or 'FAILURE' if the report status checking is a failure.
ReferenceNumber	string	Unique number provided as the response for running group reports API request.
reportGroupId	string	Generating group reports ID.
reportName	sting	Name of the report.
reportStatus	string	Provides the report status as 'NOTIFIED' if the group report is generated successfully or an error message is displayed.
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": {
"reportFailureCount": "0",
"reports": [
{
"reportId": "samplejk34-0925bccf-29f0-42f2-8896-77c57aea2198",
"reportName": " AccountTransaction ",
"reportTitle": "",
"reportStatus": "NOTIFIED",
"errorCode": "",
"reportGroupId": " AccountTransaction ",
"errorMsg": ""
}
],
"replyType": "SUCCESS",
"reportSuccessCount": "1",
"referenceNumber": "sample2djj-6c394d0e-9802-49ae-bdd3-9ccaed431ecd",
"success": "true",
"reportGroupId": " AccountTransaction ",
"noOfReports": "1",
"statusCode": "200"
}
}