CsvExportJobDto

Represents the current status and progress of a CSV export job.
Returned when starting an export or polling for status.
Use this to track progress and obtain the download URL when complete.

Properties

Name	Type	Description
code	string	Unique code identifying this export job. Use this code to poll for status via GET /clients/export/csv/{code}.
Unique code identifying this export job. Use this code to poll for status via GET /clients/export/csv/{code}.
status	enum	Queued InProgress Completed Failed Cancelled
Queued InProgress Completed Failed Cancelled
totalItems	integer	Total number of clients to export. Set when the export job starts processing.
Total number of clients to export. Set when the export job starts processing.
processedItems	integer	Number of clients that have been written to the CSV so far. Compare with TotalItems to calculate progress percentage.
Number of clients that have been written to the CSV so far. Compare with TotalItems to calculate progress percentage.
downloadUrl	string	URL to download the generated CSV file. Only available when Status is Completed. This is a time-limited SAS URL that expires after the export job's expiry date.
URL to download the generated CSV file. Only available when Status is Completed. This is a time-limited SAS URL that expires after the export job's expiry date.
startedDate	string	When the job started processing (UTC). Null if the job hasn't started yet (status is Queued).
When the job started processing (UTC). Null if the job hasn't started yet (status is Queued).
completedDate	string	When the job completed processing (UTC). Null if the job hasn't completed yet (status is Queued or InProgress). Set for both successful completion and failure.
When the job completed processing (UTC). Null if the job hasn't completed yet (status is Queued or InProgress). Set for both successful completion and failure.
createdDate	string	When the export job was created (UTC).
When the export job was created (UTC).

JSON Example

{
  "code": "string",
  "status": "Queued",
  "totalItems": 150,
  "processedItems": 75,
  "downloadUrl": "string"
}

CsvExportJobDto

Properties

JSON Example

Used By Operations