Skip to main content

Accessing the Reports via API

The reports can also be generated and downloaded via the APIs.

Generate a Report

This API will submit a request to generate report. A report can be generated in four file formats i.e., PDF, Excel, JSON, and CSV.

URL:
{versionNumber}/products/Privacy/report/generate

Parameters

Name

Description

Type

versionNumber

REST API version

Path

SessionId

Session Identifier

Header

requestObj

Request Object

Body


Sample Call:
http://localhost:8088/dgcontroller/services/v1/products/Privacy/report/generate 

Request Body: 

CODE
{
  "requestId":5, 
  "format":"PDF" 
} 

OR

{
  "identifierValues":["abc@abc.com"],
  "format":"PDF"
}

The “requestId” is the ID generated using the submit API and “identifierValues” is the list of values of strong identifier.

Response Body:
It will display a success message on the screen.

Download the Report

This API will post a request to download a report which is generated using the above API. This API will download the report in any of specified file format i.e., JSON, PDF, Excel, and CSV.

URL:
{versionNumber}/products/privacy/report/download   

Parameters

Name                    

Description    

 Type

versionNumber 

REST API version            

 Path

SessionId

Session identifier

Header

requestObj 

 Request object

Body

Sample Call:
http://localhost:8088/dgcontroller/services/v1/products/Privacy/report/download

Request Body: 

CODE
{
  "requestId":5, 
  "format":"PDF" 
} 

OR 

{
  "identifierValues":["abc@abc.com"],
  "format":"PDF"
}

 

Response Body:
In case of success, file will be downloaded on the host machine. 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.