Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

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"
}
}

For Linux-based environments, you can execute the runreport.sh shell script, by using an appropriate payload structure with the relevant response parameters, so as to call the report API with a unique access token to run or generate the report. A sample runreport.sh shell script file with a relevant payload structure and appropriate response parameters is provided as follows:

The following sample runreport.sh shell script comprises a basic payload structure with specific response parameters and the BASIC API Key authentication method has been applied in accordance with the specified payload structure. Based on the provided access token with the relevant set of response parameters, the report will run or get generated only after the successful generation of the specified access token. It is essential that the appropriate username and password credentials, which are used to access the Sigma Application, are specified properly in the runreport.sh shell script, as shown in the following code snippet:

Code Block
username="terrim"
password="canvas"
resp=$(curl --location --request POST 'http://localhost:9081/sigma/rest/reports/generate-token' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=66582CD7C3C1EEA0711D1DC7ECE8B5E3' \
--data-raw "{
   "action":"GENERATE_TOKEN",
   "authType":"BASIC",
   "username": $username,
   "password": $password
}")
echo $resp
responseType=$(echo $resp | jq -r '.headerMap.replyType')
atoken=$(echo $resp | jq -r '.headerMap.accessToken')
replyType="success"
if [ $replyType == $responseType ]
then
	curl --location --request POST 'http://localhost:9081/sigma/rest/reports/generate' \
	--header 'Content-Type: application/json' \
	--header 'Cookie: JSESSIONID=26233F01ED769AB1485D79AC3421F6C1' \
	--data-raw "{
		"action": "RUN_REPORT",
		"reportId": "7bd8091e-c2c3-47a7-a7d4-48ff477ddd28",
		"accessToken":$atoken
	 }"
else
 echo "The API Authorization failed so we cannot process the request. Kindly check the generate-token payload"
fi