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
Metadata & Tags
Retrieve A Metadata Record
Metadata & Tags
Retrieve A Metadata Record
GET
/
api
/
v1
/
metadata
/
{id}
{
"$uri": "/api/v1/metadata/a1b2c3d4e5f67890",
"custom": {},
"date_collected": "2023-11-07T05:31:56Z",
"date_sequenced": "2023-11-07T05:31:56Z",
"description": "<string>",
"external_sample_id": "a1b2c3d4e5f67890",
"library_type": "WGS",
"location_lat": 0,
"location_lon": 0,
"location_string": "<string>",
"name": "<string>",
"platform": "454 sequencing",
"sample": {
"$ref": "/api/v1/samples/a1b2c3d4e5f67890"
},
"sample_type": "Isolate",
"starred": false,
"updated_at": "2023-11-07T05:31:56Z"
}
GET a single metadata record by its ID.
Path Parameters
Response
200 - application/json
Successful operation
The response is of type object
.
{
"$uri": "/api/v1/metadata/a1b2c3d4e5f67890",
"custom": {},
"date_collected": "2023-11-07T05:31:56Z",
"date_sequenced": "2023-11-07T05:31:56Z",
"description": "<string>",
"external_sample_id": "a1b2c3d4e5f67890",
"library_type": "WGS",
"location_lat": 0,
"location_lon": 0,
"location_string": "<string>",
"name": "<string>",
"platform": "454 sequencing",
"sample": {
"$ref": "/api/v1/samples/a1b2c3d4e5f67890"
},
"sample_type": "Isolate",
"starred": false,
"updated_at": "2023-11-07T05:31:56Z"
}