Join us for an event September 26!
How to Streamline RNA-Seq analysis and increase productivity—point, click, and done
Page History
...
/projects
POST, PUT
Creates or modifies a project. Returns data for the specified project.
...
Required parameters
| Parameter | Type | Description |
|---|---|---|
project OR project_id | string integer | The name of the project. The ID of the project. |
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| owner | string | Sets the project owner |
| name | string | Sets the project name |
| description | string | Sets the project description |
| collaborator | string | If this parameter is specified, then “role” must also be specified. If the role parameter is “remove” then the specified collaborator is removed from the project, otherwise role must be a valid project role (Collaborator or Viewer). |
...
The name, id, description, owner, disk usage, last modified time, and data of the project
400: Returned if the project parameter is missing.
...
404: Returned on a GET request if no project with the specified name exists
Example
http://example.com:8080/flow/api/v1/projects?project=My%20Project
{
"name": "My Project",
"id": "12",
"description": "",
"owner": "0", "
"diskUsage": "7 GB",
"lastModifiedTimeStamp": 1496757541589,
"lastModifiedDate": "Jun 6,2017",
"data": [
"Unaligned reads"
]
}
/projects/list
POST, PUT, GET
...
The name, id, description, owner, disk usage, last modified time, and data of each project the user has permission to view.
...
Required parameters
| Parameter | Type | Description |
|---|---|---|
project_ids OR project | string string | Project IDs separated by “,” The name of the project. |
Responses
200: application/json
...
The name, id, files, and attributes of each sample in the project
Data
/data
POST,PUT
Uploads a file for analysis.
...
Parameter | Type | Description |
|---|---|---|
filename OR filepath | string string | The name of the file being uploaded. The location of the file on the server. |
file | binary | The file content. \[If filename is specifi\] |
project OR project_id | string integer | The id name of the project to add the sample to. |
...
The ID of the project to add the sample to. |
Optional parameters
Parameter | Type | Description |
|---|---|---|
sample | integer | The id of the sample to add file to. Without this parameter a new sample will be created. |
owner | string | The username of the user that should be the owner of the data. The data will count against this user’s quota, if one is configured. By default, the owner will be the user account that uploads the data. |
upload_folder | string | If the file is uploaded through the servlet it will be put in this directory, if the owner has permission to access it. |
...
setPageLoadThresholdInSeconds
| Additional assistance |
|---|
|
| Rate Macro | ||
|---|---|---|
|
...
Overview
Content Tools