Versions Compared

Version Old Version 2 New Version 3
Changes made by

Lakshminarayanan1 S CTOO

Rojer Benny CTOO

Saved on

Key

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

To use the Sigma Report APIs, you need to generate a personal access token. Access token is like password and you need to keep it confidential. Do not hardcode the access token in your application code.
Sigma enables you to generate tokens for the reports by using API Key or , BASIC methodology and ARXOAUTH methodology.

1. Generating access tokens – API Key method

...

Query Parameters are as follows:

Name

Description

Sample Values

action

String indicating the action to be executed. GENERATE_TOKEN is the default action value for generating tokens.

GENERATE_TOKEN

authType

Generating access token method.

APIKEY

clientId

Client ID shared by the team.

8HIG1002H6

clientToken

Client Token provided by the team for report generation.

sample72695bf9-3932-4f60-88b5-2f-2hjd

Response Parameters are as follows:

Parameter

Type

Description

replyType

string

For reply type, the report status will be returned as 'SUCCESS' if generating token is successful or 'FAILURE' if generating token is a failure.

accessToken

string

Access token for using Sigma Report APIs.

Sample Response

Code Block
{
"headerMap": {
"replyType": "success",
"success": "true",
"accessToken": " sample61d74837-2e77-4ede-a967-2c84b30-dws-b3b4f 7"
}
}

2. Generating access tokens – BASIC method

...

Query Parameters are as follows:

Name

Description

Sample Values

action

String indicating the action to be executed. GENERATE_TOKEN is the default action value for generating tokens.

GENERATE_TOKEN

authType

Generating access token method.

BASIC

username

Provided user name.

terrim

password

Provided password.

canvas

Response Parameters are as follows:

Parameter

Type

Description

replyType

string

For reply type, the report status will be returned as 'SUCCESS' if generating token is successful or 'FAILURE' if generating token is a failure.

accessToken

string

Access token for using Sigma Report APIs.

Sample Response

Code Block
{
"headerMap": {
"replyType": "success",
"success": "true",
"accessToken": " sample61d74837-2e77-4ede-a967-2c84b30-dws-b3b4f 7"
}
}

  1. Generating access tokens – ARXOAUTH token method

    In order to generate access tokens using ARXOAUTH token method, it is necessary to provide ARXOAUTH token as payload.

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

    Query Parameters are as follows:

Name

Description

Sample Values

action

String indicating the action to be executed. GENERATE_TOKEN is the default action value for generating tokens.

GENERATE_TOKEN

authType

Generating access token method.

ARXOAUTH

userTicket

This is the ARX authentication token. Provide this token as payload to get access token for Sigma Reports API.

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImFyeF9kZWZhdWx0In0.eyJzdWIiOiJjYW52YXMiLCJmbmFtZSI6ImNhbnZhcyIsInVzZXJzdGF0dXMiOiIxIiwiZW50aXR5bGlzdCI6WyJDQU5WQVMiXSwidXNlck5vIjoiMjAyNDA0MDAwMDIxIiwicm9sZXMiOlsiU0lHTUFHUlAiLCJDVFNUVURJT0dSUCIsIk9QX1VTRVIiLCJBTEwiXSwiaXNzIjoiaHR0cDovLzE3Mi4xNi4yMC4xMDoxMDM1MS9hcngtc3NvL29hdXRoLyIsImF1ZCI6ImRlZmF1bHQiLCJsbmFtZSI6ImNhbnZhcyIsInNfaWQiOjIxNjksInNjb3BlIjoib3BlbmlkIiwibmlja25hbWUiOiJjYW52YXMiLCJ1c2VyVHlwZSI6IjEiLCJleHAiOjE3MjUzNzAwMjEsImxhbmciOiJlbl9VUyIsImlhdCI6MTcyNTM2OTEyMSwianRpIjoiZWM0NDA4MmEtZjY2ZC00YzE2LWFlOGUtNzE2ZmFjNTdmOWE0IiwiZW50aXR5IjoiQ0FOVkFTIn0.YU4yu1NOY-wOShwpm8IC89GoW_sBb8ivlp108EIraODMQ6K3YfM_VKwW9JEMRX3ga4xOKeOQH9dyl1v_AtTBhSV6nDN6IGWrx_wCiae-CM9lTjMPQ_tJ5puwZZNmwPcC9juYbXFQ0ypbMGoVDcqcLZbFMitqjGFZ3x8CNRCnDlhPYRM0prqJ00QwaQyVL5x307o5g8laokbCsit0zTOeMnOvLpuNEhB7MCthXlCPVJ-95eTdpIU6tyo70Ido79gb3D1UtuzkporLeVoT9RnTtxK4yH4T4h9MkyeMuX_pbmaMZZJ8ZNFGnkGSZl2dqf-W8zfN6LysnrmX8dgYuDFLHA

Response Parameters are as follows:

Parameter

Type

Description

replyType

string

For reply type, the report status will be returned as 'SUCCESS' if generating token is successful or 'FAILURE' if generating token is a failure.

accessToken

string

Access token for using Sigma Report APIs.

Sample Response