Base URL: /v2, Version: 2.0.0
Basespace REST API
For descriptions of the V1 API, see V1 API Reference.
| Operation | Description |
|---|---|
| GET /applications | Get a list of available applications |
| GET /applications/{id} | Get information about an app |
| GET /applications/{id}/qcthresholds | Get a list of QC thresholds applied to an analysis workflow |
| PUT /applications/{id}/qcthresholds | Add or update the QC thresholds applied to an analysis workflow |
| GET /applications/{id}/settings | Get the settings of an application or workflow |
| GET /applications/{id}/workflowdependencies | Get a list of workflow dependencies on an analysis workflow |
| PUT /applications/{id}/workflowdependencies | Add or update the workflow dependencies of an analysis workflow |
| POST /applications/{id}/workflows | Create or update an analysis workflow |
| Operation | Description |
|---|---|
| GET /appsessions | Get a list of analyses |
| DELETE /appsessions/{id} | Delete a specific analysis |
| GET /appsessions/{id} | Get information about an analysis |
| POST /appsessions/{id} | Update an analysis |
| GET /appsessions/{id}/comments | Get a list of comments made about an analysis |
| GET /appsessions/{id}/logfiles | Get a list of logs of an analysis |
| GET /appsessions/{id}/properties | Get a list of properties of an analysis |
| POST /appsessions/{id}/properties | Add or update properties of an analysis |
| DELETE /appsessions/{id}/properties/{name} | Delete a property of an analysis |
| GET /appsessions/{id}/properties/{name} | Get information about a property of an analysis |
| GET /appsessions/{id}/properties/{name}/items | Get a list of items from a property of an analysis |
| POST /appsessions/{id}/stop | Stop an analysis from running |
| Operation | Description |
|---|---|
| DELETE /trash | Delete all items in the trash |
| GET /trash | Get a list of items in the trash |
| GET /trash/{id} | Get information about an item in the trash |
| POST /trash/{id}/restorefromtrash | Restore an item from the trash back to its active state |
| Operation | Description |
|---|---|
| GET /users/{id} | Get information about a user |
| GET /users/{id}/settings | Get a list of the user's settings |
| POST /users/{id}/settings | Update the user's settings |
| GET /users/current | Get information about the current user's account |
| GET /users/current/subscription | Get information about the user’s subscriptions |
| GET /users/current/usage | Get usage statistics for the user |
| GET /users/current/workgroups | Get a list of workgroups the user belongs to |
| GET /workgroups/{id} | Get information about a workgroup |
| Operation | Description |
|---|---|
| GET /biosamples | Get a list of biosamples |
| GET /biosamples/{biosampleid}/labrequeues | Get a list of a biosample’s lab requeues |
| GET /biosamples/{id} | Get information about a biosample |
| POST /biosamples/{id} | Update a Biosample |
| GET /biosamples/{id}/libraries | Get a list of a biosample’s libraries |
| GET /biosamples/{id}/runlanesummaries | Get information about biosample’s lane mapping |
| POST /biosamples/bulkupdate | Update the default project of many biosamples |
| Operation | Description |
|---|---|
| GET /datasets | Get a list of datasets |
| GET /datasets/{id} | Get information about a dataset |
| POST /datasets/{id} | Update an existing dataset |
| GET /datasets/{id}/comments | Get a list of comments made about a dataset |
| GET /datasets/{id}/files | Get a list of files of a dataset |
| GET /datasettypes/{id} | Get information about a dataset type |
| GET /projects/{id}/datasets | Get a list of datasets in a project |
| Operation | Description |
|---|---|
| GET /instrumentstatistics | Get instrument statistics |
| GET /runs/{id}/files | Get a list of files of a run |
| Operation | Description |
|---|---|
| GET /labrequeues | Get a list of lab requeues |
| GET /labrequeues/{id} | Get information about a specific labrequeue |
| POST /libraries/{libraryid}/labrequeues | Add a lab requeue request for more yield from a library |
| POST /librarypools/{poolid}/labrequeues | Add a lab requeue request for more yield from a pool |
| POST /preprequests/{preprequestid}/labrequeues | Add a lab requeue request for more yield from a biosample |
| Operation | Description |
|---|---|
| GET /laneqcthresholds | Get a list of QC thresholds applied to lanes |
| PUT /laneqcthresholds | Add or update the QC thresholds applied to lanes |
| GET /lanes/{id} | Get information about a lane |
| POST /lanes/{id} | Update a lane |
| GET /lanes/{id}/comments | Get a list of comments on a lane |
| Operation | Description |
|---|---|
| GET /libraries | Get a list of libraries |
| Operation | Description |
|---|---|
| POST /librarypools/{id} | Update a pool |
| GET /librarypools/{id}/libraries | Get a list of libraries of a pool |
| Operation | Description |
|---|---|
| GET /projects/{id} | Get information about a project |
x-access-token
header
application
http://login.illumina.com
OAuth V2 authentication
| category | Return all apps that belong to a specific category that a user has access to (examples include: Native, Workflow, Other). Only a single category can be specified in a given call |
query | string | |
| references | Returns all analysis workflows that a user has access to that were created from a particular app, denoted by its unique slug ID |
query | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { DateCreated , DatePublished , Id , Name , VersionNumber } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string | |
| id | The Id of the resource |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | path | string | ||
| propertieslimit | Returns only the specified number of properties for the application. |
query | integer | |
| propertyitemslimit | Returns only the specified number of property items per property for the application |
query | integer |
Uses default content-types: application/json
OK
An error occurred.
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
List the QC thresholds to be updated. You must include the name of the metric to be thresholded, the type of logical operator, the dataset type unique ID to apply the threshold to, and the threshold values.
| qcthresholds | query |
object[]
,
comma separated (qcthresholds=aaa,bbb)
|
||
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
Add the required triggers for the analysis workflow to launch. Workflows can depend on a certain amount of biosample actual yield to show up or they can depend on another app completing.
| version | query | string | ||
| dependencies | query |
object[]
,
comma separated (dependencies=aaa,bbb)
|
||
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
Create an analysis workflow using the settings, app, and version of an existing appsession.
Uses default content-types: application/json
| id | Applicaiton Id |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| appid | Filter by ID of application used |
query | integer | |
| applicationfamilyslugs | Filter by application family |
query |
string[]
,
comma separated (applicationfamilyslugs=aaa,bbb)
|
|
| datemodified | query | string | ||
| executionstatus | Filter by execution status |
query | string | |
| qcstatus | Filter by QC status |
query | string | |
| deliverystatus | Filter by delivery status |
query | string | |
| name | query | string | ||
| output.projects | Filter by ID of output project |
query |
integer[]
,
comma separated (output.projects=aaa,bbb)
|
|
| input.runs | Filter by ID of run input |
query |
integer[]
,
comma separated (input.runs=aaa,bbb)
|
|
| input.biosamples | Filter by ID of biosample input |
query |
integer[]
,
comma separated (input.biosamples=aaa,bbb)
|
|
| include | Additional resources to include |
query | string , x ∈ { Children , Logs } | |
| propertyfilters | Filter by appsessions include the specified property names |
query |
string[]
,
comma separated (propertyfilters=aaa,bbb)
|
|
| usercreatedby | ID of user who created appsession |
query | integer | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Name , Id , AppId , ExecutionStatus , ModifiedOn , DateCreated , AppName , TotalSize , QcStatus , DeliveryStatus } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Appsession ID |
path | string | |
| preserve | Preserve "Metadata", to keep records, but not files, of an appsession |
query | string |
Uses default content-types: application/json
OK
Reset Content
An Error Occured
| id | Appsession ID |
path | string | |
| include | Additional resources to include |
query | string , x ∈ { Children , Logs } | |
| showhiddenitems | ShowHiddenItems |
query | string |
Uses default content-types: application/json
OK
An error occurred.
The Execution Status cannot be changed since it is an automated status tracking the progress of running the app. The Qc Status may be updated only when the Execution Status is set to “Complete” or “Aborted”. Delivery Status may be updated at any time. Comments can be added when updating statuses.
Uses default content-types: application/json
| id | Appsession ID |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Appsession ID |
path | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Timestamp } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Appsession ID |
path | string | |
| filesetid | query | string | ||
| extensions | Filter by file extension |
query | string | |
| directory | Filter by directory path (root is /) |
query | string | |
| includesubdirectories | Whether to return subdirectories |
query | boolean | |
| excludevcfindexfolder | Whether to exclude VCF index folders |
query | boolean | |
| excludebamcoveragefolder | Whether to exclude BAM coverage folders |
query | boolean | |
| excludesystemfolder | Whether to exclude system folders |
query | boolean | |
| excludeemptyfiles | Whether to exclude empty files |
query | boolean | |
| filehrefcontentresolution | Resolves the HrefContent to the direct file URI to avoid a hop to GET: files/{id}/content |
query | boolean | |
| statuses | Optionally filter by status (default complete) |
query |
string[]
,
comma separated (statuses=aaa,bbb)
|
|
| turbomode | query | boolean | ||
| pathprefix | To be pre-fixed in the path of the file |
query | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , DateCreated , Path , Name } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Appsession ID |
path | string | |
| propertieslimit | Limit the # of properties returned |
query | integer | |
| propertyitemslimit | Limit the # of property items returned per property |
query | integer | |
| propertyfilters | Filter by property name |
query |
string[]
,
comma separated (propertyfilters=aaa,bbb)
|
|
| showhiddenitems | Show Hidden projects and Datasets |
query | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Name } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
Uses default content-types: application/json
| id | Appsession ID |
path | string |
Uses default content-types: application/json
OK
Created
An Error Occured
| id | Appsession ID |
path | string | |
| name | Property name |
path | string |
Uses default content-types: application/json
No Content
An Error Occured
| id | Appsession ID |
path | string | |
| name | Property name |
path | string | |
| showhiddenitems | Hidden filter |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Appsession ID |
path | string | |
| name | Property name |
path | string | |
| showhiddenitems | Hidden filter |
query | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { DateCreated } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
The analysis must have a status of “Running” or “Pending”. Stopping a running analysis will update the status to “Aborted”. Stopping a pending analysis will update the status to “Canceled”.
Uses default content-types: application/json
| id | Appsession ID |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| biosamplename | Only return biosamples with the given BioSampleName(s) |
query |
string[]
,
comma separated (biosamplename=aaa,bbb)
|
|
| include | Sub elements to include in the response |
query |
string[]
,
comma separated (include=aaa,bbb)
|
|
| propertynamestartswith | query |
string[]
,
comma separated (propertynamestartswith=aaa,bbb)
|
||
| status | Only return biosamples with the given Status(es) |
query |
string[]
,
comma separated (status=aaa,bbb)
|
|
| labstatus | Only return biosamples with the given LabStatus(es) |
query |
string[]
,
comma separated (labstatus=aaa,bbb)
|
|
| projectid | Only return biosamples with the specified default projects or datasets in those projects |
query |
string[]
,
comma separated (projectid=aaa,bbb)
|
|
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , BioSampleName , Nickname , DateModified , UserOwnedBy , Project , Subject , LabStatus , Status } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
Setting a new default project of a biosample will redirect newly created datasets to the new project.
Uses default content-types: application/json
Uses default content-types: application/json
OK
An error occurred.
All lab requeues, from each of the types, are listed here. A pool lab requeue will show up on the list of lab requeues for all biosamples that make up the pool.
| biosampleid | Biosample ID |
path | string | |
| type | Specify which type of lab requeue to be listed e.g. NewBioSampleLibrary, AdditionalYieldOfLibraryPool, or AdditionalYieldOfFinishedLibrary. |
query | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , DateModified , Type , RequestedAdditionalYield , DateCreated } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Biosample ID |
path | string | |
| include | Sub elements to include in the response |
query |
string[]
,
comma separated (include=aaa,bbb)
|
Uses default content-types: application/json
OK
An error occurred.
Setting a new default project of a biosample will redirect newly created datasets to the new project. The biosample status may transition between any of the possible statuses. Setting a biosample to canceled will automatically cancel all analyses in progress for that biosample.
Uses default content-types: application/json
| id | Biosample ID |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Biosample ID |
path | string | |
| include | Sub elements to include in the response: LibraryIndex, YieldInformation |
query |
string[]
,
comma separated (include=aaa,bbb)
|
|
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , Name , DateCreated , DateModified , ProjectName , Biomolecule , Status , UserOwnedBy } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Biosample ID |
path | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { CreatedOn , ModifiedOn } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| include | Can specify to return Properties, which returns an additional properties section for each dataset. Or return AppSessionRoot, which returns information about the root analysis of a workflow in the AppSession section for each dataset it applies to. |
query |
string[]
,
comma separated (include=aaa,bbb)
|
|
| propertyfilters | Specify which properties to include in the properties section, e.g. Input.BioSamples, Input.Libraries, or Input.Runs. |
query |
string[]
,
comma separated (propertyfilters=aaa,bbb)
|
|
| datasettypes | Return datasets of this type or excluding this type. Supports comma-separated lists. |
query |
string[]
,
comma separated (datasettypes=aaa,bbb)
|
|
| qcstatus | Return datasets of this QC status. |
query |
string[]
,
comma separated (qcstatus=aaa,bbb)
|
|
| uploadstatus | Return datasets of this file upload status. |
query |
string[]
,
comma separated (uploadstatus=aaa,bbb)
|
|
| inputbiosamples | Return datasets related to this biosample ID. |
query |
integer[]
,
comma separated (inputbiosamples=aaa,bbb)
|
|
| inputruns | Return datasets related to this run ID. |
query |
integer[]
,
comma separated (inputruns=aaa,bbb)
|
|
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Name , DateCreated , DateModified , AppSessionName , ApplicationName , ProjectName } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
A list of datasets
An Error Occured
| id | Dataset ID |
path | string |
Uses default content-types: application/json
OK
An error occurred.
The QcStatus of a dataset may only be updated when the UploadStatus is set to “Complete”. The QcStatus may then be updated to one of the following values: QcFailed or QcPassed. A comment may be entered into the Comment field when updating the dataset QcStatus.
Uses default content-types: application/json
| id | Dataset ID |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Dataset ID |
path | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Timestamp } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| filesetid | query | string | ||
| extensions | Filter by file extension |
query | string | |
| directory | Filter by directory path (root is /) |
query | string | |
| includesubdirectories | Whether to return subdirectories |
query | boolean | |
| excludevcfindexfolder | Whether to exclude VCF index folders |
query | boolean | |
| excludebamcoveragefolder | Whether to exclude BAM coverage folders |
query | boolean | |
| excludesystemfolder | Whether to exclude system folders |
query | boolean | |
| excludeemptyfiles | Whether to exclude empty files |
query | boolean | |
| filehrefcontentresolution | Resolves the HrefContent to the direct file URI to avoid a hop to GET: files/{id}/content |
query | boolean | |
| statuses | Optionally filter by status (default complete) |
query |
string[]
,
comma separated (statuses=aaa,bbb)
|
|
| turbomode | query | boolean | ||
| pathprefix | To be pre-fixed in the path of the file |
query | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , DateCreated , Path , Name } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string | |
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Dataset type ID |
path | string | |
| include | query |
string[]
,
comma separated (include=aaa,bbb)
|
Uses default content-types: application/json
OK
An error occurred.
Get instrument statistics for given serial numbers and time range. Returned data can be grouped by month or week.
| serialnumbers | Comma-separated list of serial numbers. |
path | string | |
| fromdate | From date in user ISO 8601 format. |
path | none | |
| todate | To date in ISO 8601 format. Defaults to current date if not specified. |
query | none | |
| binby | BinBy can be 'week' or 'month'. |
query | string | |
| timezone | User timezone for binning. |
path | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , Name } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string | |
| id | The Id of the resource |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| status | Only return labrequeues with the given Status(es) |
query |
string[]
,
comma separated (status=aaa,bbb)
|
|
| type | Only return labrequeues with the given LabRequeueTypes(s) |
query |
string[]
,
comma separated (type=aaa,bbb)
|
|
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , DateModified , Type , RequestedAdditionalYield , DateCreated } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string | |
| id | The Id of the resource |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Labrequeue ID |
path | string |
Uses default content-types: application/json
OK
An error occurred.
The QC thresholds are applied to a user's account. Any runs uploaded in that user's context will automatically have all lanes of the flowcell undergo automatic QC based on the QC thresholds. Thresholds are saved either to a lane, or to a lane and read number.
| id | The Id of the resource |
query | string |
Uses default content-types: application/json
OK
An error occurred.
List the QC thresholds to be updated.
| qcthresholds | query |
object[]
,
comma separated (qcthresholds=aaa,bbb)
|
||
| id | The Id of the resource |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
The status of a lane may be updated to the following values: QcFailed, QcPassed.
Uses default content-types: application/json
| id | path | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Lane ID |
path | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Timestamp } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| status | query |
string[]
,
comma separated (status=aaa,bbb)
|
||
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , Name , DateCreated , DateModified , ProjectName , Biomolecule , Status , UserOwnedBy } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string | |
| id | The Id of the resource |
query | string |
Uses default content-types: application/json
OK
An error occurred.
The requested additional yield is the total yield to be requested for the whole pool. To estimate how much yield will be added from each library, divide the requested additional yield by the number of libraries in the pool.
Uses default content-types: application/json
| libraryid | path | string |
Uses default content-types: application/json
OK
An error occurred.
The status of a pool may be updated to the following values: Active, Failed, Consumed or QCFailed. Setting a pool to Failed or QCFailed will exclude all FASTQ datasets created from the pool from app launch when one of its biosamples are selected as an input. This is also reflected on the Actual Yield of each biosample in the pool.
Uses default content-types: application/json
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| include | Sub elements to include in the response: LibraryIndex, YieldInformation |
query |
string[]
,
comma separated (include=aaa,bbb)
|
|
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , Name , DateCreated , DateModified , ProjectName , Biomolecule , Status , UserOwnedBy } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string | |
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
Uses default content-types: application/json
| poolid | path | string |
Uses default content-types: application/json
OK
An error occurred.
Request a requeue for a new library, given an existing preprequest.
Uses default content-types: application/json
| preprequestid | path | string |
Uses default content-types: application/json
OK
An error occurred.
| propertieslimit | query | integer | ||
| propertyitemslimit | query | integer | ||
| include | query |
string[]
,
comma separated (include=aaa,bbb)
|
||
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
Get information about a project
An error occurred.
| id | Project ID |
path | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Name , DateCreated , DateModified , AppSessionName , ApplicationName , ProjectName } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| extensions | The file extensions to filter by (comma-separated) |
query | string | |
| directory | The directory path to filter by (root is /) |
query | string | |
| filehrefcontentresolution | Resolves the HrefContent to the direct file URI to avoid a hop to GET: files/{id}/content |
query | boolean | |
| recursive | If a 'directory' is provided, files in subfolders of the given directory are also included |
query | boolean | |
| statuses | Optionally filter by status (default complete) |
query |
string[]
,
comma separated (statuses=aaa,bbb)
|
|
| include | Possible values: 'Subdirectories', 'TotalCount' |
query |
string[]
,
comma separated (include=aaa,bbb)
|
|
| pathprefix | To be pre-fixed in the path of the file |
query | string | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , DateCreated , Path , Name } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string | |
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
Deleting all items from the trash is a non-reversible action. All items and their files will be removed from Sequence Hub permanently.
Uses default content-types: application/json
OK
An error occurred.
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { DateDeleted , TotalSize } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
The ID used in this endpoint is the ID given to the item when it is put in the trash, not the original ID from the resource, i.e. its project ID. Please use the GET /v2/trash endpoint to find the item’s trash ID.
Uses default content-types: application/json
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| options | query | string | ||
| include | query |
string[]
,
comma separated (include=aaa,bbb)
|
||
| id | The Id of the resource |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| id | The Id of the resource |
query | string |
Uses default content-types: application/json
OK
An error occurred.
Information about storage and compute usage will be returned for the user’s personal account, as well as any workgroups they own.
| includeloggedinuser | query | boolean | ||
| periods | query | integer | ||
| refreshcache | query | boolean | ||
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Start , End } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string | |
| id | The Id of the resource |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| includeloggedinuser | Includes current user |
query | boolean | |
| activeonly | Excludes inactive workgroups |
query | boolean | |
| refreshcache | This will force a refresh on the workgroup subscriptions |
query | boolean | |
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , Name } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string |
Uses default content-types: application/json
OK
An error occurred.
| options | query | string | ||
| include | query |
string[]
,
comma separated (include=aaa,bbb)
|
||
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| sortby | The field(s) used to sort the result set |
query | string , x ∈ { Id , DateModified , Name } | |
| offset | The starting offset to read |
query | integer | |
| limit | The maximum number of items to return |
query | integer | |
| sortdir | The sort direction for the result set |
query | string | |
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
A user may have settings such as how they receive notifications and expiration time on lab requeues. This currently only works with a session cookie.
Uses default content-types: application/json
| id | The Id of the resource |
path | string |
Uses default content-types: application/json
OK
An error occurred.
| id | Workgroup ID |
path | string |
Uses default content-types: application/json
OK
An error occurred.
The total amount of Data the user is permitted to use.
The type of dependency to add, valid operators include: “BioSampleYield”, “AppCompletion”
Sections containing a list of attributes and their values defining the app launch dependency, specific to the dependency type given
Optional nested dependencies, not needed for BioSampleYield or AppCompletion dependency types
The name of the analysis workflow
Description of the analysis workflow
The ID of the appsession to gather settings from when creating the workflow
The name of the appsession
Immutable
A summary of why or how the status changed, seen in the tooltip when clicking an analysis’ status
Possible values are: QcPassed, QcFailed, Discarded
Possible values are: Undefined, DoNotDeliver, OnHold, ReadyForDelivery, DeliveryFailed, DeliveryInProgress, Delivered
Limited to 1024 characters
List the IDs of the biosamples to be updated
Define the ID of the project to set as the default project
Possible values are: Active, Failed, Consumed, QCFailed
Name of the metric
Valid operators: “Equal”, “LessThan”, “GreaterThan”, “LessThanOrEqual”, “GreaterThanOrEqual”, “NotEqual”, “Between”, “Outside”
The dataset type slug, e.g. illumina.issac.v4
Integer values of the thresholds. A comma separated list can be given for the “Between” and “Outside” operators
The name of the biosample, which must be unique and only contain alphanumeric, dash, or underscore letters
Define the ID of the project to set as the default project
The name of the plate or tube containing the biosample, typically its barcode
The location of the biosample within a plate or other container, typically the well it is in
Possible values are: New, Active, Done, QcFailed, Canceled
Optional
Reference link
Name of the setting, must use alphanumeric, dash or underscore characters
Data type, possible values include: bool, string