Species API endpoint
The shared list of species subjects can belong to.
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/taxonomies/species/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/taxonomies/species/(read-only, public projects, no token) - Response keys:
species(detail, create, update),species(list) - Permissions: see the permissions page
- Uniqueness:
nameunique across BrainSTEM - Deleting: refused (400) while
anatomicalreference,strain,strainapproval,subjectrecords point to it
Fields
[required] fields must be sent on create; [read-only] fields are returned but cannot be set. A nestable relation can be traversed in filters (filter{field.other}) and sideloaded with include[]=field.*; other relations can only be compared with ids (filter{field}=<id>). See the query syntax.
| Field | Description |
|---|---|
id | UUID string [read-only] |
name | string [required]; max 100 characters |
popular_name | string; max 100 characters |
description | string; max 2000 characters |
rrid | string; max 100 characters; nullable. Research Resource Identifier (RRID) for tracking standardized research resources |
rrid_url | string [read-only] |
external_identifiers | JSON object; nullable. External identifiers and their source URLs from various databases (NCBI, JAX, DOI, etc.) |
comments | string |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/taxonomies/species/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('species', load_all=True)
records = resp['species']
Use example (MATLAB API tool)
resp = client.load('species', 'load_all', true);
records = resp.species;
Response example
{
"species": [
{
"id": "<id>",
"name": "Species 1",
"popular_name": "",
"description": "",
"rrid": "",
"rrid_url": "",
"external_identifiers": {},
"comments": ""
}
],
"meta": {
"page": 1,
"per_page": 100,
"total_results": 1,
"total_pages": 1
}
}
Add
- Allowed portals: private
- Request method: POST
- URL:
https://www.brainstem.org/api/private/taxonomies/species/ - Data: JSON object with at least the required fields
- Responses:
201Created;400Bad request (validation errors per field);403Not allowed
Use example (Python API tool)
resp = client.save('species', data={"name": "Species 1"})
record = resp.json()['species']
Use example (MATLAB API tool)
created = client.save(struct('name', 'Species 1'), 'species');
record = created.species;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/taxonomies/species/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('species', id='<id>')
record = resp.json()['species']
Use example (MATLAB API tool)
out = client.load('species', 'id', '<id>');
record = out.species;
Response example
{
"species": {
"id": "<id>",
"name": "Species 1",
"popular_name": "",
"description": "",
"rrid": "",
"rrid_url": "",
"external_identifiers": {},
"comments": ""
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/taxonomies/species/<id>/ - Data: JSON object with the fields to change. Lists (
projects,tags, …) and JSON payloads (details, coordinates) are replaced as a whole: read the record first and send the full list or object. - Responses:
200OK;400Bad request;403Not allowed;404Not found
Use example (Python API tool)
resp = client.save('species', id='<id>', data={"name": "Species 1 (renamed)"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'name', 'Species 1 (renamed)'), 'species', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/taxonomies/species/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('species', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'species');
JSON field schemas
Schema for the external identifiers of a species. The REST API returns these JSON fields as stored and validates writes against the schemas below. Every version is published at https://www.brainstem.org/schemas/Species/<Type>/<version>.json and never changes; see Public schemas.
External Identifiers
- type code
ExternalIdentifiers· version 1.0.0 · schema
Add external identifiers from databases like NCBI, JAX, DOI, etc. Include URLs when available.
| Property | Description |
|---|---|
source | choice [required]; one of NCBI, JAX, MGI, RGD, BDSC, ZFIN, RBRC, IMSR, Criver, Taconic, Envigo, Harlan, DOI, Custom, Other; default "NCBI" |
id | Identifier: text [required] |
url | URL (optional): text |
Illustrative payload:
[
{
"source": "NCBI",
"id": "text",
"url": "text"
}
]
Data model
The fields are described for the web forms on the Species data model page.