Page History
...
Parameter | Type | Description |
|---|---|---|
sample_id OR sample OR sample_name | integer string | The ID of the sample. The name of the sample. |
project_id OR project OR project_name | integer string | The ID of the sample's project The name of the sample’s project. |
...
Parameter | Type | Description |
|---|---|---|
project_id OR project OR project_name | integer string | The ID of the project. The name of the project. |
Responses
...
Parameter | Type | Description |
|---|---|---|
project_Id OR project OR project_name | integer string | The ID of the project. The name of the project. |
Optional parameters
Parameter | Type | Description |
|---|---|---|
sample_Id id OR sample OR sample_name | integer string | The ID of the sample. The name of the sample. |
...
The name, description, file, deletable status, creation date, and creator for each pipeline.
Example
...
/
...
pipelines/
...
[
{
"name": "My Pipeline",
"description": "",
"protocolFile": {
"path": "\/home\/flow\/.partekflow\/partek_db\/protocol\/P20150629140508365_0.json"
},
"deletable": true,
"creationDate": "1472850094644",
"creator": {
"arg$1": {
"section": "Pipelines",
"date": 1435604708365,
"user": "",
"userID": 0,
"name": "My Pipeline",
"description": ""
}
}
}
]
/pipelines/input
POST, GET
Returns the required inputs for a specified pipeline
...
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. |
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. |
| add_directory | string | Add permission for the user to browse files in this directory. |
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 |
...
id, name, displayName, isOnline, tasksInQueue, diskQuota, diskUsage (in gigabytes)
/users/unset_private_directory
POST
Clears the specified user's private directory
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 |
Responses
200: application/json
id, name, displayName, isOnline, tasksInQueue, diskQuota, diskUsage (in gigabytes)
Tasks
/tasks
POST, GET
Returns a summary of tasks run on the server
...
Overview
Content Tools