get
https://api.ornament.health/thesaurus-api/public/v1.0/biomaterials
Returns the list of Biomaterials used in Ornament.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
lang | string | Yes | Language used for biomaterial titles. Example: EN. |
Supported languages: EN, DE, ES, PT, RU.
Request example
curl --location 'https://sandbox-api.ornament.health/thesaurus-api/public/v1.0/biomaterials?lang=EN' \
--header 'Authorization: ••••••'
Response
Returns an array of biomaterial objects.
Response schema
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Unique biomaterial identifier. |
title | string | Yes | Biomaterial title in the requested language. |
Notes
- This method returns only thesaurus data as used in Ornament.
- Biomaterial IDs can be used to interpret other thesaurus responses, for example the
biomaterialIdfield in the biomarkers dictionary method.
Response example
[
{
"id": 1,
"title": "Serum"
},
{
"id": 2,
"title": "Blood"
},
{
"id": 3,
"title": "Erythrocytes"
},
{
"id": 4,
"title": "Saliva"
},
{
"id": 5,
"title": "Urine"
},
{
"id": 6,
"title": "Plasma"
},
{
"id": 7,
"title": "Feces"
},
{
"id": 8,
"title": "Hairs"
},
{
"id": 9,
"title": "CSF"
},
{
"id": 10,
"title": "Nails"
},
{
"id": 11,
"title": "Amniotic fluid"
},
{
"id": 12,
"title": "Urogenital scraping"
},
{
"id": 13,
"title": "Pharyngeal swab"
},
{
"id": 14,
"title": "Prostatic fluid"
},
{
"id": 15,
"title": "Semen"
},
{
"id": 16,
"title": "Exhaled air"
},
{
"id": 17,
"title": "Tick body fragments"
},
{
"id": 18,
"title": "Bone marrow"
}
]
Bad request
Not found