This API is represented by single endpoint, please find all details below.
Available implementations
We provide implementations in following laguages/platforms:
- JavaScript (could be integrated into any web application).
- iOS: Objective-C, Swift
- Java: Android
If your language is not on the list, let us know and we add implementation for it!
If you are interested on how File selector API works, please see protocol specification below.
HTTP endpoint specification
URL: https://api.sequencing.com/DataSourceList
HTTP method: GET
Response format: JSON
HTTP headers
| # | Header name | Header value | Data type | Mandatory | Notes |
|---|---|---|---|---|---|
| 1 | Authorization |
Bearer authorization_token |
string | yes |
Header that allows to authenticate your request to Sequencing.com systems. Where "authorization_token" is a token received as a result of OAuth2 authentication. Check here for more details. |
Request parameters
| # | Parameter name | Data type | Allowed parameter values | Mandatory | Notes |
|---|---|---|---|---|---|
| 1 | all | string | true | no | Requests files to be returned for all folders |
| 2 | uploaded | string | true | no | Requests files to be returned for "My uploaded files" |
| 3 | shared | string | true | no | Requests files to be returned for "Files shared with me" |
| 4 | fromApps | string | true | no | Requests files to be returned for "Files saved from my apps" |
Any combination of request parameters parameters is allowed and there should be at least one specified.
Since any combination of request parameters is possible, here are few valid examples:
- My uploaded files & Files shared with me
https://api.sequencing.com/DataSourceList?uploaded=true&shared=true
- My uploaded files & Files saved from my apps:
https://api.sequencing.com/DataSourceList?uploaded=true&fromApps=true
Response if a list of objects of following structure
| # | Response field | Data type | Mandatory | Description |
|---|---|---|---|---|
| 1 | Id | string | yes |
Unique file identifier. This identifier is used in other APIs like AppChains and App Market |
| 2 | Name | string | yes | File name with extension |
| 3 | Ext | string | yes | Genetic file extension i.e. vcf.gz, bam, ... |
| 4 | FileCategory | string | yes |
File category. Could take values "Uploaded", "Community", "FromApps" |
| 5 | FileType | string | yes | File type. Could be "Sequence", "Other" |
| 6 | FileSubType | string | yes | File sub type |
| 7 | FriendlyDesc1 | string | no | Friendly description for a file |
| 8 | FriendlyDesc2 | string | no | Extended friendly description for a file |
| 9 | Population | string | no | Population |
| 10 | Sex | string | no | Sex, i.e. Male/Female |
| 11 | DateAdded | string | yes | Date file was added |
Response example
[
{
"DateAdded": null,
"Ext": "vcf.gz",
"FileCategory": "Community",
"FileSubType": "Other",
"FileType": "Other",
"FriendlyDesc1": "Homer",
"FriendlyDesc2": "Pretty fly for a white guy",
"Id": "227679",
"Name": "Sample genome",
"Population": "Caucasian (American)",
"Sex": "Male",
"WasUsedPreviously": false
},
{
"DateAdded": null,
"Ext": "vcf.gz",
"FileCategory": "Community",
"FileSubType": "Other",
"FileType": "Other",
"FriendlyDesc1": "Marge",
"FriendlyDesc2": "Wise white woman and mother of three",
"Id": "227682",
"Name": "Sample genome",
"Population": "Caucasian (American)",
"Sex": "Female",
"WasUsedPreviously": false
},
{
"DateAdded": null,
"Ext": "vcf.gz",
"FileCategory": "Community",
"FileSubType": "Other",
"FileType": "Other",
"FriendlyDesc1": "Bart",
"FriendlyDesc2": "El Barto is 10 and the son of Homer and Marge",
"Id": "237697",
"Name": "Sample genome",
"Population": "Caucasian (American)",
"Sex": "Male",
"WasUsedPreviously": false
}
]
In case token is not valid following response will be sent in a response
{"Detail":null,"ExceptionType":"System.ServiceModel.FaultException","Message":"Invalid apiKey passed"}
You may try following curl command to test API. Substitute "authorization_token" with the token you received as a result of OAuth2 authentication
curl -H "Authorization: Bearer authorization_token" "https://api.sequencing.com/DataSourceList?all=true"
