ReportJob Object

The ReportJob object represents the job status and contains status-specific properties for a given report job.

A job with status='error' will populate the message field with an explanation of why the job failed. A job with status='complete' will populate the files field with a list of file URLs corresponding to the report bundles for the specified job id.

The ReportJob object is read-only.


Name Type Read Only Required Description
jobId String yes no The job's unique identifier.
status Enum yes no The current status of the job. Values: queued, processing, completed, cancelled, error.
message String yes no The message indicating why the job failed (if status=error).
files String[] yes no The list of uploaded file URLs for the corresponding job (if status=completed).

Back To Top