Job

Asynchronous backend work. Poll job(id) until status is terminal.

interface Job {
  createdAt: DateTime!
  error: JobError
  finishedAt: DateTime
  id: JobID!
  operation: String!
  progress: JobProgress
  requestedBy: Employee
  requeuedFrom: Job
  residentialParkId: ResidentialParkID!
  startedAt: DateTime
  status: JobStatus!
  warnings: [JobWarning!]!
}

Fields

Job.createdAt ● DateTime! non-null scalar

When the job was accepted.

Job.error ● JobError object

Why the job failed. Set only when status is FAILED.

Job.finishedAt ● DateTime scalar

When the job reached a terminal state.

Job.id ● JobID! non-null scalar

Unique identifier, also the support reference of a failure.

Job.operation ● String! non-null scalar

The GraphQL operation that submitted the job.

Job.progress ● JobProgress object

Progress while the job runs.

Job.requestedBy ● Employee object

The employee who triggered the job. Null for API keys and system triggers.

Job.requeuedFrom ● Job interface

The job this one re-runs, when it was created by requeueJob.

Job.residentialParkId ● ResidentialParkID! non-null scalar

The park the job belongs to. Authorization and fairness scope.

Job.startedAt ● DateTime scalar

When the job was last claimed by a pod.

Job.status ● JobStatus! non-null enum

Lifecycle state.

Job.warnings ● [JobWarning!]! non-null object

Degradations and partial failures the job worked around.

Returned By

adminJobs query ● job query ● jobs query

Member Of

Job interface ● RequeueJobPayload object ● TourRouteOptimizationJob object

Implemented By

TourRouteOptimizationJob object