API Basics
Samples
Metadata & Tags
Analyses
- The Analysis Resource
- GETRetrieve All Analyses
- GETRetrieve An Analysis
- GETRetrieve Analysis Results
- GETRetrieve Analysis Files
- GETRetrieve Analysis Output File Details
- The Classification Resource
- GETRetrieve All Classifications
- GETRetrieve A Classification
- GETRetrieve Classification Results
- GETRead-Level Results
- The Panel Resource
- GETRetrieve All Panels
- GETRetrieve A Panel
- GETPanel Results
- The Alignment Resource
- GETRetrieve All Alignments
- GETRetrieve An Alignment
Documents
Samples
Retrieve A Sample
GET
/
api
/
v1
/
samples
/
{id}
{
"$uri": "/api/v1/samples/a1b2c3d4e5f67890",
"created_at": "2023-11-07T05:31:56Z",
"error_msg": "<string>",
"filename": "<string>",
"metadata": {
"$ref": "/api/v1/metadata/a1b2c3d4e5f67890"
},
"owner": {
"$ref": "/api/v1/users/a1b2c3d4e5f67890"
},
"primary_classification": {
"$ref": "/api/v1/classifications/a1b2c3d4e5f67890"
},
"project": {
"$ref": "/api/v1/projects/a1b2c3d4e5f67890"
},
"size": 123,
"status": "awaiting_data",
"tags": [],
"updated_at": "2023-11-07T05:31:56Z",
"visibility": "public"
}
GET a single sample by its ID.
Path Parameters
Response
200 - application/json
Successful operation
The response is of type object
.
{
"$uri": "/api/v1/samples/a1b2c3d4e5f67890",
"created_at": "2023-11-07T05:31:56Z",
"error_msg": "<string>",
"filename": "<string>",
"metadata": {
"$ref": "/api/v1/metadata/a1b2c3d4e5f67890"
},
"owner": {
"$ref": "/api/v1/users/a1b2c3d4e5f67890"
},
"primary_classification": {
"$ref": "/api/v1/classifications/a1b2c3d4e5f67890"
},
"project": {
"$ref": "/api/v1/projects/a1b2c3d4e5f67890"
},
"size": 123,
"status": "awaiting_data",
"tags": [],
"updated_at": "2023-11-07T05:31:56Z",
"visibility": "public"
}
Assistant
Responses are generated using AI and may contain mistakes.