Response JSON Parameters

This section provides the list of parameters in the JSON Response.

• requestInstanceId - (String). Request Instance ID of the export process
• downloadlink - (String). Click the link to download the document.
• status - (String). Status of the export

Sample Response

• The following sample response is generated, when the Download report request is in progress.

  Report Request Accepted
  {
    "status": "PENDING",  
    "requestInstanceId": "100"
  }
  Report Request is being processed
  {
   "status": "RUNNING",
   "requestInstanceId": "100"}
  Report Request Generation Failed
  {
   "status": "FAIL",  
   "reportInstanceId": "100"}
  Report Request Generation Completed  - for higher volume
  {
   "status": "COMPLETE", 
   "reportInstanceId": "100",  
   "downloadLink": "<url>"
  } 

• The following sample response is generated , when the download request is processed and the PAR URL to download the report is included in the response. You can copy the PAR URL and paste it in a Web browser, to download the report in CSV format.

  
  "requestInstanceId":"183",
  "downloadLink": "<URL>",
  "status":"COMPLETE"

• The following sample response is generated , when the download request is in pending status.

  "{"requestInstanceId":"161","status":"PENDING"}