v1/queue

GET /v1/queue

List the current user’s queue items. While the task a queue item represents is still processing, its status will be pending. Completed, successful tasks will have status done, and will have a reference to the created package. Unsuccessful tasks will have status FAILED, and an array of errors.

Request Headers:  

• Authorization – Bearer token

Query Parameters:  

• package – Include only the results for the given package_id.

Response Headers:  

• Content-Type – application/json

Response JSON Array of Objects:  

• id – Queue entry’s id
• status (string) – One of pending, done, or failed
• request (url) – Relative URL to the request
• package (url) – Relative URL to the created package. This field is not present unless status is done.
• error (string_array) – An array of errors encountered while validating the bag. This field is not present unless the status is failed.
• created_at (date) – Datetime when the object was created
• updated_at (date) – Datetime when the object was last changed

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Unauthenticated

GET /v1/queue/(id)

Return a specific queue item. While the task the queue item represents is still processing, its status will be PENDING. Completed, successful tasks will have status DONE, and will have a reference to the created bag. Unsuccessful tasks will have status FAILED, and an array of errors.

Request Headers:  

• Authorization – Bearer token

Parameters:

• id – Queue item’s id. This id is not the same as the bag’s id.

Response Headers:  

• Content-Type – application/json

Response JSON Object:  

• id – Queue entry’s id
• status (string) – One of pending, done, or failed
• request (url) – Relative URL to the request
• package (url) – Relative URL to the created package. This field is not present unless status is done.
• error (string_array) – An array of errors encountered while validating the bag. This field is not present unless the status is failed.
• created_at (date) – Datetime when the object was created
• updated_at (date) – Datetime when the object was last changed

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Unauthenticated
• 403 Forbidden – User does not own the resource, and is not an admin.
• 404 Not Found – Not found