Page History
...
Returns the list of visible projects on the server.
Responses
200: application/json
The name, id, description, owner, disk usage, last modified time, and data of each project the user has permission to view.
Example
http://example.com:8080/flow/api/v1/projects/list
[
{
"name": "My Project",
"id": "12",
"description": "",
"owner": "0",
"data": [
"Unaligned reads"
]
},
{
"name": "DNA-Seq Project",
"id": "13",
"description": "",
"owner": "0",
"data": [
"Variants"
]
}
]
Optional parameters
The following filters can be applied to the list:
| Parameter | Type | Description |
|---|---|---|
| project_ids | string | Retrieve specific projects. IDs joined by , |
| project_id | integer | Retrieve a single project by ID |
| project | string | Retrieve a single project by name |
| sample | string | List projects that contain a sample with the specified name. |
| file_name | string | List projects that contain a file matching the specified sub-string. |
| user_id | integer | List projects for which the specified user is a member. |
| user_name | string | List projects for which the specified user is a member. |
By default this returns each project visible to the user making the request.
Responses
200: application/json
The name, id, description, owner, user roles, output folders, disk usage, time of last modification, and data of each project.
/projects/import
POST
Creates a project from the specified zip.
...
A zip file containing the project content.
/projects/
...
output_folders
POST
Deletes the specified project.
Required GET
List the output folders for visible projects.
Optional parameters
| Parameter | Type | Description | ||
|---|---|---|---|---|
| project_ids OR project | string string | Project IDs separated by “,” The name of the project. | string | Retrieve specific projects. IDs joined by , |
| project_id | integer | Retrieve a single project by ID | ||
| project | string | Retrieve a single project by name | ||
| sample | string | List projects that contain a sample with the specified name. | ||
| file_name | string | List projects that contain a file matching the specified sub-string. | ||
| user_id | integer | List projects for which the specified user is a member. | ||
| user_name | string | List projects for which the specified user is a member. |
Responses
200: application/json
The full path for each projects output directory. If no user_id or user_name is specified then the directory returned will be for the user making the request.
/projects/files
GET
List each file associated with a project.
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| project_ids | string | Retrieve specific projects. IDs joined by , |
| project_id | integer | Retrieve a single project by ID |
| project | string | Retrieve a single project by name |
| sample | string | List projects that contain a sample with the specified name. |
| file_name | string | List projects that contain a file matching the specified sub-string. |
| user_id | integer | List projects for which the specified user is a member. |
| user_name | string | List projects for which the specified user is a member. |
Responses
200: application/json
The list of files
/projects
...
/folders
GET
List the each folder which has one or more files associated with a project.
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| project_ids | string | Retrieve specific projects. IDs joined by , |
| project_id | integer | Retrieve a single project by ID |
| project | string | Retrieve a single project by name |
| sample | string | List projects that contain a sample with the specified name. |
| file_name | string | List projects that contain a file matching the specified sub-string. |
| user_id | integer | List projects for which the specified user is a member. |
| user_name | string | List projects for which the specified user is a member. |
Responses
200: application/json
The list of folders
Samples
/samples
POST, PUT
Creates a sample. Returns data for the specified sample.
...
Overview
Content Tools