basic

List task queue

get/queue

Request

Base URL
/api/v0 (relative, and the document was published on a file host, not at the API’s origin)
Auth
HTTP basic
TypeScript
https://skmtc.dev/amz-racing/apis/rosbag-bazaar-api/docs/queue/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

offsetinteger

orderingstring

runningstring

Include running tasks, default is true

finishedstring

Include finished tasks, default is true

queuedstring

Include queued tasks, default is true

Response

Returns an array of tasks.

detail_typestring required

identifierstring required

prioritynumber required

descriptionstring required

Simple description to identify the type of task

assigned_tostring required

Name of worker assigned to the task.

createdstring date-time required

Date the task was added to the queue.

last_updatedstring date-time required

Date the task was updated to the queue.

stateinteger required

State of the task.

taskstring required

The task.

successboolean required

runtimenumber required

worker_labelsstring required

Worker that can take this task.

Example response

[
  {
    "identifier": "1",
    "last_updated": "2000-01-23T04:56:07.000+00:00",
    "task": "task",
    "detail_type": "TaskSummary",
    "created": "2000-01-23T04:56:07.000+00:00",
    "success": true,
    "description": "description",
    "runtime": 6.027456183070403,
    "state": 0,
    "priority": 1000,
    "worker_labels": "worker_labels",
    "assigned_to": "assigned_to"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.