Skip to content

Occurrence ​

Type: object additionalProperties: false

FieldRequiredTypeDescription and constraints
idYesstringformat: "uuid"
schedule_idYesstringformat: "uuid"
triggerYesOccurrenceTrigger
scheduled_atYesstringCron due time for a scheduled occurrence, or command acceptance time for a manual occurrence. This is not the execution start time. format: "date-time"
stateYesOccurrenceState
created_atYesstringformat: "date-time"
updated_atYesstringformat: "date-time"
session_idYesstring / nullformat: "uuid"
run_idYesstring / nullformat: "uuid"
run_statusYesstring / null
observed_atYesstring / nullformat: "date-time"
execution_started_atYesstring / nullformat: "date-time"
finished_atYesstring / nullformat: "date-time"
run_error_codeYesstring / null
sync_error_codeYesstring / null
error_codeYesstring / null
attemptsYesintegerminimum: 0
next_attempt_atYesstring / nullformat: "date-time"

JSON Schema ​

json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "schedule_id",
    "trigger",
    "scheduled_at",
    "state",
    "created_at",
    "updated_at",
    "session_id",
    "run_id",
    "run_status",
    "observed_at",
    "execution_started_at",
    "finished_at",
    "run_error_code",
    "sync_error_code",
    "error_code",
    "attempts",
    "next_attempt_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "schedule_id": {
      "type": "string",
      "format": "uuid"
    },
    "trigger": {
      "$ref": "#/components/schemas/OccurrenceTrigger"
    },
    "scheduled_at": {
      "type": "string",
      "format": "date-time",
      "description": "Cron due time for a scheduled occurrence, or command acceptance time for a manual occurrence. This is not the execution start time."
    },
    "state": {
      "$ref": "#/components/schemas/OccurrenceState"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "session_id": {
      "type": "string",
      "nullable": true,
      "format": "uuid"
    },
    "run_id": {
      "type": "string",
      "nullable": true,
      "format": "uuid"
    },
    "run_status": {
      "type": "string",
      "nullable": true
    },
    "observed_at": {
      "type": "string",
      "nullable": true,
      "format": "date-time"
    },
    "execution_started_at": {
      "type": "string",
      "nullable": true,
      "format": "date-time"
    },
    "finished_at": {
      "type": "string",
      "nullable": true,
      "format": "date-time"
    },
    "run_error_code": {
      "type": "string",
      "nullable": true
    },
    "sync_error_code": {
      "type": "string",
      "nullable": true
    },
    "error_code": {
      "type": "string",
      "nullable": true
    },
    "attempts": {
      "type": "integer",
      "minimum": 0
    },
    "next_attempt_at": {
      "type": "string",
      "nullable": true,
      "format": "date-time"
    }
  }
}

All schemas · HTTP API