Export status

The customer portal makes this REST call to the Third-Party Gateway to get the status of all exports or reports that have been created.

Export status details

Request URL

POST api/v1/tenants/{tenantId}/export/status

Response code

200 - The request successfully processed.

Response schema

{

"createdBy": {"type": "string”, "description": "The ID of what created the record"},

"createdDate": {"type": "string($date-time)", "description": "The date the record was created"},

"downloaded": {"type": "boolean”},

"errorMessage": {"type": "string”},

"id": {"type": "string”, "description": "The ID of the record"},

"name": {"type": "string”},

"size": {"type": "number”},

"state": {"type": "string”, "description": "Enum:[ Completed, Failed, Queued ]"},

"tenantId": {"type": "string”},

"updatedBy": {"type": "number”, "description": "The ID of what updated the record"},

"updatedDate": {"type": "string($date-time)", "description": "The date the record was last updated"},

}

Response sample

[

{

"createdBy": "string",

"createdDate": "2023-01-12T12:07:14.298Z",

"downloaded": true,

"errorMessage": "string",

"id": "string",

"name": "string",

"size": 0,

"state": "Completed",

"tenantId": "string",

"updatedBy": "string",

"updatedDate": "2023-01-12T12:07:14.298Z"

}

]