v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Scheduling Task

Create a scheduling task

Creates a scheduling task for the supplied application and job stage. The task starts with the requested urgency and optional initial note; the server assigns the scheduling-task type. An idempotency key is required so retries return the original result instead of creating another task.

post/v1/tasks

Request body

application_idstring required

an application ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

job_stage_idstring required

a job stage ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

is_urgentboolean

Sets the task urgency. Defaults to false.

notestring

Optional initial internal task note; omit to create no note.

Example request

{
  "application_id": "app_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "job_stage_id": "stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"
}

Response

Success

idstring required

Canonical task ID (tsk_ followed by 32 lowercase hexadecimal UUID characters).

is_urgentboolean required

queue_idstring nullable required

Canonical task queue ID (que_ followed by 32 lowercase hexadecimal UUID characters).

tagsstring[] required

is_debrief_requiredboolean required

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

app_urlstring uri required

Example response

{
  "id": "tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "application": {
    "id": "app_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "candidate": {
      "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789"
    },
    "job": {
      "id": "job_a1b2c3d4e5f64789a1b2c3d4e5f64789"
    }
  },
  "job_stage": {
    "id": "stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "assignee": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "queue_id": "que_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "notes": [
    {
      "author": {
        "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
      }
    }
  ]
}