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.
Authorizations
API tokens are passed as Bearer tokens.
Body
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.
^(?:app_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"app_a1b2c3d4e5f64789a1b2c3d4e5f64789"
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.
^(?:stg_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"
Sets the task urgency. Defaults to false.
Optional initial internal task note; omit to create no note.
Response
Success
Canonical task ID (tsk_ followed by 32 lowercase hexadecimal UUID characters).
^tsk_[0-9a-f]{32}$"tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789"
NEEDS_AVAILABILITY, WAITING_FOR_CANDIDATE, READY_TO_SCHEDULE, READY_TO_RESCHEDULE, HOLD, READY_TO_SEND_TO_CANDIDATE, SCHEDULED, COMPLETED, CANCELED, NEEDS_DEBRIEF Canonical task queue ID (que_ followed by 32 lowercase hexadecimal UUID characters).
^que_[0-9a-f]{32}$"que_a1b2c3d4e5f64789a1b2c3d4e5f64789"
ISO 8601 timestamp.
ISO 8601 timestamp.