Task List

Method for viewing a list of tasks

Request Parameters

GET /api/clients/v1/tasks/

Headers

• Content-Type: application/json
• Authorization: Bearer $access_token

Query Parameters

Parameter	Type	Constraints	Description	Example
project_id	integer	> 0, required	Project ID associated with the VOD source	2
status	string[]	IN_PROGRESS / COMPLETED / FAILED	Task status	IN_PROGRESS
subject_type	string	domain, s3_resource, vod	Type of object being acted upon
subject_id	integer	> 0	ID of object being acted upon
limit	integer	> 0	Number of items per page	50
offset	string	> 0	Pagination offset	0

Response Parameters

JSON body

Parameter	Type	Description
count	integer	Total number of tasks
next	string	URL to next page
previous	string	URL to previous page
results	object[]	List of tasks

200 OK

List of tasks

{
  "count": 2,
  "next": "http://testserver/api/clients/v1/tasks?project_id=2&status=COMPLETED",
  "previous": null,
  "results": [
    {
      "id": "b8d2fc52-d922-46fb-9ce3-e005188d039c",
      "task_type": "CREATE_S3_RESOURCE",
      "subject_type": "s3_resource",
      "subject_id": 16,
      "owner_id": 11,
      "status": "COMPLETED",
      "percentage": 100,
      "completed_at": "2024-01-01T16:16:16.000000Z"
    },
    {
      "id": "ac1c7c6c-f63e-4fc2-9339-864af20a9e87",
      "task_type": "ENABLE_VOD",
      "subject_type": "vod",
      "subject_id": 19,
      "owner_id": 11,
      "status": "COMPLETED",
      "percentage": 100,
      "completed_at": "2024-01-01T21:21:21.000000Z"
    }
  ]
}

400 Bad Request

Invalid or missing required query parameters

{
  "project_id": [
    "This field is required."
  ]
}

401 Unauthorized

Authentication credentials missing or invalid

{
  "detail": "Given token not valid for any token type",
  "code": "token_not_valid",
  "messages": [
    {
      "token_class": "AccessToken",
      "token_type": "access",
      "message": "Token is invalid or expired"
    }
  ]
}

403 Forbidden

Only tasks associated with the current user's project are accessible

{
  "detail": "Only project participants can view this project's tasks"
}