Page History

...

Parameter	Type	Description
project OR project_filtername	string	Only return tasks in this project
user_filter	string	Only return tasks run by this user
The name of a project
project_id	integer	The ID of a project
user_name	string	The username of a user
user_id	integer	The ID of a user
status	string	The task status: Pending, Waiting, Running, Done, Canceled, Failed

Responses

200: application/json

...

404: Returned if the specified project can not be found.

POST, GET

Cancels the specified task(s)

Optional parameters

Parameter	Type	Description
project OR project_name	string	The name of a project
project_id	integer	The ID of a project
user_name	string	The username of a user
user_id	integer	The ID of a user
status	string	The task status: Pending, Waiting, Running, Done, Canceled, Failed

Responses

200: application/json

The number of tasks canceled

403: Returned if the user does not have permission to view the queue.

404: Returned if the specified project can not be found.

Example

http://example.com:8080/flow/api/v1/queue/tasks

...

id, name, displayName, isOnline, tasksInQueue, diskQuota, diskUsage (in gigabytes)

Tasks

POST, GET

Returns a summary of tasks run on the server

...

Parameter	Type	Description
id	integer	A specific task ID
user_name OR user_id	string integer	The name of a user The ID of a user
project OR project_id	string integer	The name of a project The ID of a project
status	string	A task status (e.g. Done, Running, Pending)
task	string	The type of task (e.g. Bowtie)

...