Running Individual Reports

The API returns an unique Reference Number that can be used as a payload for checking report status and downloading 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. RUN_REPORT is the default action value for running Sigma reports.	RUN_REPORT
reportId	Indicates the Report ID.	sampel0925bccf-29f0-42f2-8896-77c57a-dde-ea2198
accessToken	Indicates the access token.	sample61d74837-2e77-4ede-a967-2c84b30-dws-b3b4f 7

Note:

In order to obtain the Report ID log-on to Sigma application and right click the report on the left-hand side of the page and click Copy Report ID.

Response Parameters are as follows:

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

{
  "headerMap" : 
  {
    "replyType" : "SUCCESS",
    "reportId" : "samplejk34-0925bccf-29f0-42f2-8896-77c57aea2198",
    "referenceNumber" : "sample2djj-6c394d0e-9802-49ae-bdd3-9ccaed431ecd",
    "success" : "true",
    "statusCode" : 200,
    "status" : "SUCCESS"
  }
}