Join us for an event September 26!
How to Streamline RNA-Seq analysis and increase productivity—point, click, and done

Flow Documentation

Partek Flow Documentation

Page tree

Versions Compared

Old Version 3

changes.mady.by.user admin

Saved on

compared with

New Version 4

changes.mady.by.user admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

500: Returned if there is an error queueing the pipeline

 

Example

http://example.com:8080/flow/api/v1/pipelines/run?project=My%20Project&pipeline=My%Project&inputs=1,2

 

pipeline_queued: 1805,1806

 

Queue

 

/queue

 

POST, GET

Downloads summary information about the queue

 

Optional parameters

 

 

Parameter

Type

Description

project_filter

string

Only return tasks in this project

user_filter

string

Only return tasks run by this user

 

Responses

 

200: application/json

running:  the number of tasks currently running commands

waiting:  the total number of tasks queued, but not running

waitingForDiskSpace:  tasks that won’t run until hard disk space is made available.  

waitingForProject:  tasks that can’t run because of the project limit

waitingForResources:  tasks that require more resources (such as memory) to run

waitingForUpstreamTask:  tasks for which the input is currently unavailable

permanentlyStalled:  tasks that are waitingForDiskSpace or for which there is no worker with sufficient capacity to run

hasPendingCommands:  true if there are commands which can run if more resources are made available

 

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

 

{

 "running": 1,
 "waiting": 4,
 "waitingForDiskSpace": 0,
 "waitingForProject": 0,
 "waitingForResources": 3,
 "waitingForUpstreamTask": 1,
 "permanentlyStalled": 0,

 "hasPendingCommands":"true"

}

 

/queue/tasks

 

Downloads information about the queued tasks

 

Optional parameters

 

 

Parameter

Type

Description

project_filter

string

Only return tasks in this project

user_filter

string

Only return tasks run by this user

 

Responses

 

200: application/json

id, task, runStatus, progress, submitted, started, end

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": 2590,
   "task": "Post-alignment QA\/QC",
   "runStatus": "Pending",
   "progress": 0,
   "submitted": "21 Oct 2016, 03:33 PM CDT",
   "started": "NA",
   "end": "NA"
 },
 {
   "id": 2589,
   "task": "TMAP - 5.0.0",
   "runStatus": "Running",
   "progress": 5,
   "submitted": "21 Oct 2016, 03:33 PM CDT",
   "started": "21 Oct 2016, 03:33 PM CDT",
   "end": "21 Oct 2016, 03:38 PM CDT"
 }
]

 

Users

 

/users

 

POST, PUT

Add and configure a specified user

 

Optional parameters

 

One of the following may be specified:

 

Parameter

Type

Description

user_name

string

The username of the user.  If the user does not exist it will be created.

user_id

integer

The ID of the user

 

If neither is specified, then the user specified by the username parameter (or the logged-in user) will be used

 

 

Parameter

Type

Description

distinguished_name

string

When creating a new user, this parameter specifies the LDAP distinguished name.

user_password

string

When creating a new user, this parameter specifies their initial Flow password.  If this parameter is absent and this is not an LDAP user then the user will receive an email with a link to set their initial password.

email

string

The user’s email address.  When creating a new user, this parameter is required.

display_name

string

The name that other users will see

enabled

boolean

Whether the user is able to log in.

admin

boolean

Whether the user has the admin role.  The system requires at least one admin account.

private_directory

string

If present, the directory will be created and the user will be given permission to use it.

quota

integer

The size of the user’s quota (in gigabytes) or “none” to remove any quota

notify_when_tasks_finish

boolean

Whether the user will receive an email when a task they have queued completes

notify_when_added_to_project

boolean

Whether the user will receive an email when they are added as a collaborator or viewer to a project

decimal_precison

integer

How many digits to show after the decimal point for numeric values in tables

 

 

Responses

 

200: application/json

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

400: Returned if the user_name or user_id parameter is specified, but does not identify a valid user.

 

GET

Returns information about a specified user

 

Optional parameters

 

One of the following may be specified:

 

Parameter

Type

Description

user_name

string

The username of the user

user_id

integer

The ID of the user

 

if neither is specified, then the user specified by the username parameter (or the logged-in user) will be used

 

Responses

 

200: application/json

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

400: Returned if the user_name or user_id parameter is specified, but does not identify a valid user.

 

Example

 

http://example.com:8080/flow/api/v1/users?user_id=0

 

[
 {
   "id": 0,
   "name": "admin",
   "displayName": "Administrator",
   "isOnline": true,
   "tasksInQueue": 1,
   "diskUsage": 83516042096
 }
]

 

/users/list

 

GET

Returns information about all users on the system

...