Cycle Docs | API Reference | The Job Resource

The Job Resource

Attributes

id
string
The ID of the job.
queue
string
The environment and id where this job is queued.
caption
string
A short description of the Job.
events
object
A collection of timestamps for each event in the job's lifetime.
Show child fields
schedule
string
A time string signifying when the job was scheduled.
expires
string
A time string signifying when the job will expire if its not completed.
tasks
array of objects
An array of task objects.
Show child fields
hash
string
A combination of the individual task details and job details.
limit_duplicates
bool
Returns true and is set to prevent someone from trying to produce the same job quickly and in succession when the job has already queued.
creator
object
Type of creator and an identifier.
Show child fields
hub_id
string
The ID of the hub this Job is taking place in.
state
object
Information about the current state of the job.
Show child fields

Example Job

{
  "id": "5d543ec1db2ab00001078d04",
  "queue": "environment-5cec602e4146380001934759",
  "caption": "Starting Container 'Environment Discovery (DNS)'",
  "events": {
    "queued": "2019-08-14T17:02:57.324Z",
    "started": "2019-08-14T17:02:57.324Z",
    "completed": "2019-08-14T17:02:57.352Z"
  },
  "schedule": "0001-01-01T00:00:00Z",
  "expires": "2019-08-14T18:02:57.316Z",
  "tasks": [
    {
      "id": "5d543ec1db2ab00001078d05",
      "caption": "Starting Container 'Environment Discovery (DNS)'",
      "header": "container.start",
      "action": "task-action",
      "events": {
        "queued": "2019-08-14T17:02:57.324Z",
        "started": "0001-01-01T00:00:00Z",
        "completed": "0001-01-01T00:00:00Z"
      },
      "error": null,
      "steps": [],
      "state": {
        "current": "completed",
        "changed": "2019-08-14T17:02:57.352Z"
      },
      "input": {
        "id": "5cec602edb2ab00001777d1e"
      },
      "output": {
        "id": "5cec602edb2ab00001777d1e"
      },
      "failable": false
    }
  ],
  "hash": "51e6f489a1eb20f425994bb8fe24b361",
  "limit_duplicates": true,
  "creator": {
    "id": "59dafefe91238b0001ba0ccc",
    "type": "account"
  },
  "hub_id": "5a14ddd8b6393d0001976f44",
  "state": {
    "current": "completed",
    "changed": "2019-08-14T17:02:57.352Z"
  }
}