FLflox
tasks

Get Task

Changed on

Return a single task by ID.

Returns 404 if no task with the given ID exists.

get/api/v1/factory/tasks/{task_id}

Request

  • The document declares no server URL.
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

task_idinteger required

Response

Successful Response

task_idinteger required
task_typestring required
status'running' | 'completed' | 'failed' | 'cancelled' required

Valid status values for tasks.

Mirrors the CHECK constraint as of migration 1.8.0: status IN ('running', 'completed', 'failed', 'cancelled').

The claim CTE inserts tasks directly as 'running' (the claim is the dispatch; there is no separate queued phase). The three terminal values are written by process_callback and mark_task_failed.

error_messagestring nullable
error_class'transient' | 'permanent' | 'timeout' | 'dispatch_timeout'

Diagnostic class of a failed task.

Mirrors the ck_task_error_class CHECK as of migration 1.8.2: error_class IN ('transient', 'permanent', 'timeout', 'dispatch_timeout'); the column is NULL for non-failure terminals.

  • TRANSIENT: says nothing of the build itself, such as a build the coordinator lost or gave no status for.
  • PERMANENT: will not improve on retry.
  • TIMEOUT: the coordinator reported an execution timeout — a build that ran and overran its limit.
  • DISPATCH_TIMEOUT: the submit HTTP call to the coordinator itself timed out, so the build's handoff never observably started.

The last two are kept distinct so the read surface shows an execution timeout as timed_out while a submit timeout reads as failed.

created_atstring date-time required
updated_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable

Changes

  • f17e891a3eebRevision changes
    • breaking

      the response's property type changed from string to no type for status

    • info

      added to the response property allOf list for the response status

    • info

      removed the dispatch_timeout enum value from the response property for the response status

    • info

      removed the permanent enum value from the response property for the response status

    • info

      removed the timeout enum value from the response property for the response status

    • info

      removed the transient enum value from the response property for the response status

  • ffc271c8797cRevision changes
    • warning

      added the new cancelled enum value to the response property for the response status

    • warning

      added the new completed enum value to the response property for the response status

    • warning

      added the new dispatch_timeout enum value to the response property for the response status

    • warning

      added the new failed enum value to the response property for the response status

    • warning

      added the new permanent enum value to the response property for the response status

    • warning

      added the new running enum value to the response property for the response status

    • warning

      added the new timeout enum value to the response property for the response status

    • warning

      added the new transient enum value to the response property for the response status