Jobs API

No fields.

Fields (JSON object)

• jobs required

  List of jobs.

  array<Job>

  Items

  Job

  Fields (JSON object)

  • jobId (from job_id) required

    Job ID.

    JobId string
  • status required

    Status of the job.

    JobStatus

    Cases externally

    • Pending

      Job is pending.

      Value: "Pending"

    • Completed

      Job has been completed successfully.

      Value: "Completed"

    • Failed

      Job has failed.

      Value: "Failed"

    • Expired

      Job has expired and is no longer valid.

      Value: "Expired"

    • Cancelled

      Job has been cancelled.

      Value: "Cancelled"

  • job required

    Type of the job.

    string
  • queued required

    Indicates whether the job is currently queued for execution.

    boolean
  • attempts required

    Attempts of executing the job.

    integer
  • retryLimit (from retry_limit) optional

    Maximum number of retries for the job.

    integer
  • retryDelay (from retry_delay) required

    Delay in seconds for retrying the job.

    integer
  • timeout required

    Timeout for an individual execution of the job (defaults to 30 minutes).

    integer
  • createdAt (from created_at) required

    Timestamp indicating when the job was created.

    Timestamp string
  • finishedAt (from finished_at) optional

    Timestamp indicating when the job has finished (if applicable).

    Timestamp string