Category Instance
API endpoint that allows CV Categories to be viewed or edited. In addition to the normal detail page, when provided with the param nested=True, the detail endpoint shows all Terms on the category. Then on the detail page, terms can be viewed, changed, deleted and added to the Category.
» click to learn about Filtering, Ordering and more...
Accepted filters:
- search: Search in the following fields: ^name. (^startswith, $regex, =exact)
- id: ID (exact)
- created: Created (exact)
- modified: Modified (exact)
- name: Name starts with (istartswith)
- description: Description contains (icontains)
- query: Search filter on the name property (exact)
- owner: Owner Username (exact)
- owned_by: Filter on list of owned by group names [OR] (exact)
- public: Public (exact)
- deleted: Deleted (exact)
- deleted_by: Deleted by (exact)
- deleted_date: Deleted date (exact)
- label: Label contains (icontains)
- created_by: Created by Username (exact)
- modified_by: Modified by Username (exact)
Advanced Filtering
You can also filter using a json object to process all search parameters. Currently this filter supports the syntax as produced/used by the http://summitroute.github.io/react-structured-filter/ search UI.
Example
?query_expression={"category":"name","operator":"contains","value":"Y00"},
{"category":"amount","operator":">","value":"10"},
{"category":"type__name","operator":"exact","value":"ANTIBODY"}
» more info about the query_expression param..
Preset mappings
- terms: {'name': 'term_count', 'aggregate': Count(F(terms), distinct=True)}
- deleted: <function filter_deleted at 0x7f45063b6710>
- deleted_by: deleted_by__username
- owner: owner__username
- owned_by: owned_by__name
- created_by: created_by__username
- modified_by: modified_by__username
Operators
- ==
- =
- >=
- >
- <=
- <
- contains
- icontains
- exact
- iexact
- startswith
- istartswith
- endswith
- iendswith
Permission filtering
Based on the current logged in user you can filter for objects that have a particular permission set:
- can_change: True/False, show objects that you can change
- can_delete: True/False, show objects that you can delete
# not applicable - will raise NotAcceptable:
- can_view: as this is always True, you can only view items you are allowed to see
Ordering
You can order on practically any field even spanning relations.
# reverse order on owner username
?ordering=-owner
# order on related field
?ordering=category__version
API endpoint that allows CV Categories to be viewed or edited.
In addition to the normal detail page, when provided with the param *nested*=True,
the detail endpoint shows all Terms on the category.
Then on the detail page, terms can be viewed, changed, deleted and added to the Category.
None
The default modelviewset used in this project
Add JSONPatch like functionality to bulk update items.
### Bulk Delete
This view also allows for one to bulk delete items. The url needs to be appended by ``/bulk_delete/`` and the ids
need to be given by multiple query_params:
```
{current_url}/bulk_delete/?id=<id_1>,id=<id_2>
```
GET /api/v2/vocabularies/categories/052787d8-4f7e-4816-a129-680dce02cc7e/?format=api&ordering=description
{ "results": { "url": { "name": "url", "value": "https://labid-demo.embl.de/api/v2/vocabularies/categories/052787d8-4f7e-4816-a129-680dce02cc7e/?format=api", "category": "property" }, "id": { "name": "id", "category": "property", "value": "052787d8-4f7e-4816-a129-680dce02cc7e" }, "created_by": { "name": "created_by", "value": { "id": 1, "username": "admin", "full_name": "Admin User" }, "category": "property" }, "modified_by": { "name": "modified_by", "value": { "id": 1, "username": "admin", "full_name": "Admin User" }, "category": "property" }, "created": { "name": "created", "value": "2025-12-16T09:20:17.196104+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-16T09:20:17.196246+01:00", "category": "property" }, "model_name": { "name": "model_name", "category": "property", "value": "category" }, "app_name": { "name": "app_name", "category": "property", "value": "vocabularies" }, "model_type": { "name": "model_type", "category": "property", "value": "DEFAULT" }, "name": { "name": "name", "value": { "id": "052787d8-4f7e-4816-a129-680dce02cc7e", "name": "efo_study_design", "model_name": "category", "app_name": "vocabularies", "model_type": null }, "category": "property" }, "choice_label": { "name": "choice_label", "category": "property", "value": "efo_study_design" }, "description": { "name": "description", "category": "property", "value": "This vocabulary is linked to the Experimental Factor Ontology (EFO) Study Design(EFO_0001426) sub category. EFO is an application focused ontology modelling the experimental variables in multiple resources at the EBI and Open Targets. The ontology has been developed to increase the richness of the annotations that are currently made in resources and to promote consistent annotation, to facilitate automatic annotation and to integrate external data. The ontology pulls together classes from reference ontologies such as disease, cell line, cell type and anatomy and adds axiomatisation as necessary to connect areas such as disease to phenotype." }, "label": { "name": "label", "category": "property", "value": "Efo_Study_Design" }, "status": { "name": "status", "value": { "value": "ACTIVE", "label": "Active" }, "category": "property" }, "source": { "name": "source", "category": "property", "value": "EFO" }, "version": { "name": "version", "category": "property", "value": "1.0" }, "terms": { "name": "terms", "category": "property", "value": [ { "id": "be88dd0d-cb60-4446-9efc-00b60a46564b", "name": "methodological variation design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0004669", "default": false, "short_name": "methodological variation design", "image_url": "", "public": true }, { "id": "a385673a-ed27-4982-a72c-4913b2bbc7e2", "name": "RNA stability design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001783", "default": false, "short_name": "RNA stability design", "image_url": "", "public": true }, { "id": "33640f3a-2b37-4538-9375-700c211a0457", "name": "time series design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001779", "default": false, "short_name": "time series design", "image_url": "", "public": true }, { "id": "139927fc-a5fe-48db-94f3-6c0d88e739d6", "name": "stimulus or stress design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001762", "default": false, "short_name": "stimulus or stress design", "image_url": "", "public": true }, { "id": "2a0dca51-8b88-43a5-b812-73cc4c53dcf9", "name": "pathogenicity design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001761", "default": false, "short_name": "pathogenicity design", "image_url": "", "public": true }, { "id": "ce18e3d1-9066-44fa-af07-c3a22043d466", "name": "injury design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001760", "default": false, "short_name": "injury design", "image_url": "", "public": true }, { "id": "0ee7e152-fda9-4a77-a2d3-d3fdccb2453a", "name": "growth condition design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001759", "default": false, "short_name": "growth condition design", "image_url": "", "public": true }, { "id": "94e94056-51f3-4a50-929d-e2816bb90735", "name": "genetic modification design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001758", "default": false, "short_name": "genetic modification design", "image_url": "", "public": true }, { "id": "27220c4f-2381-426e-bf21-df103d40c3c9", "name": "strain or line design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001754", "default": false, "short_name": "strain or line design", "image_url": "", "public": true }, { "id": "111aa451-51b0-4c43-8dc3-ac41d8092011", "name": "organism status design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001751", "default": false, "short_name": "organism status design", "image_url": "", "public": true }, { "id": "4d824729-8055-483b-ba87-5841d15bded8", "name": "organism part comparison design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001750", "default": false, "short_name": "organism part comparison design", "image_url": "", "public": true }, { "id": "81a230b8-9b0a-4fd9-8c60-86d3d24c1669", "name": "innate behavior design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001749", "default": false, "short_name": "innate behavior design", "image_url": "", "public": true }, { "id": "ebccccdb-46ed-477b-843b-6aec46f07859", "name": "genotype design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001748", "default": false, "short_name": "genotype design", "image_url": "", "public": true }, { "id": "8846ea7b-fe84-482f-b132-be8d51c434be", "name": "imprinting design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001747", "default": false, "short_name": "imprinting design", "image_url": "", "public": true }, { "id": "018f1b18-1ee6-4d11-b7c1-dadf298f1784", "name": "twin design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001431", "default": false, "short_name": "twin design", "image_url": "", "public": true }, { "id": "a13c9371-4903-46aa-9b45-df764e48cb5b", "name": "population based design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001430", "default": false, "short_name": "population based design", "image_url": "", "public": true }, { "id": "4f1c4937-ff18-46f1-8026-ac68a9c71bfb", "name": "observational design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0000629", "default": false, "short_name": "observational design", "image_url": "", "public": true }, { "id": "7e6880d4-4b82-4e15-9cff-b8821f12cd6a", "name": "mobile element identification design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0005693", "default": false, "short_name": "mobile element identification design", "image_url": "", "public": true }, { "id": "642cd5e1-1ad2-45f9-aab2-d79182c8cbff", "name": "transposable element identification design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0005692", "default": false, "short_name": "transposable element identification design", "image_url": "", "public": true }, { "id": "ef975467-5578-4ebb-9ff7-894a2e136348", "name": "array specific design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0004668", "default": false, "short_name": "array specific design", "image_url": "", "public": true }, { "id": "43d0fd9f-1c01-46fb-b9e3-53b1a3976fdb", "name": "binding site identification design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0004664", "default": false, "short_name": "binding site identification design", "image_url": "", "public": true }, { "id": "c48f0a93-9888-4370-b312-33689b27e780", "name": "translational bias design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001787", "default": false, "short_name": "translational bias design", "image_url": "", "public": true }, { "id": "7680b4cf-ea1a-41ab-bd96-6cc0207cb0ff", "name": "secreted protein identification design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001786", "default": false, "short_name": "secreted protein identification design", "image_url": "", "public": true }, { "id": "8c0254aa-d847-49f8-93b9-71fb0f6e201e", "name": "operon identification design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001785", "default": false, "short_name": "operon identification design", "image_url": "", "public": true }, { "id": "bc8a1117-cc14-480e-8cd0-0ad3c84a6c80", "name": "genotyping design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001779", "default": false, "short_name": "genotyping design", "image_url": "", "public": true }, { "id": "37fcfee0-639b-40c5-a752-c05dd8efbd78", "name": "software variation design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001778", "default": false, "short_name": "software variation design", "image_url": "", "public": true }, { "id": "a448275e-be56-4824-88be-932a5875bbf0", "name": "self vs self design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001777", "default": false, "short_name": "self vs self design", "image_url": "", "public": true }, { "id": "cd0fa27b-956d-4f2c-b39e-bfdba514ec91", "name": "biological variation design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0004667", "default": false, "short_name": "biological variation design", "image_url": "", "public": true }, { "id": "8f502cc2-2049-4293-82c4-9ce6e4877a3a", "name": "biological replicate", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0002091", "default": false, "short_name": "biological replicate", "image_url": "", "public": true }, { "id": "07fe6ad1-aaac-4d5c-a066-0aefd319ea0b", "name": "replicate design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001776", "default": false, "short_name": "replicate design", "image_url": "", "public": true }, { "id": "a6e0b437-46a7-45cc-99d6-7427d750d8fd", "name": "reference design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001775", "default": false, "short_name": "reference design", "image_url": "", "public": true }, { "id": "59da8f0a-352b-4f7b-aa3c-21bc3768f0f0", "name": "quality control testing design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001774", "default": false, "short_name": "quality control testing design", "image_url": "", "public": true }, { "id": "2ff95f01-f7d4-43a1-9f35-c0d8447e5176", "name": "optimization design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001773", "default": false, "short_name": "optimization design", "image_url": "", "public": true }, { "id": "7fee47af-5b5d-45dc-99a6-433a962167fb", "name": "operator variation design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001772", "default": false, "short_name": "operator variation design", "image_url": "", "public": true }, { "id": "7ff6bb7c-965d-44ed-841f-5add8d388e8d", "name": "normalization testing design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001771", "default": false, "short_name": "normalization testing design", "image_url": "", "public": true }, { "id": "c35e3871-c252-4a54-a1d8-1dabd6fcb809", "name": "loop design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001770", "default": false, "short_name": "loop design", "image_url": "", "public": true }, { "id": "8353450c-68e5-4ae1-8849-fb726efb87ee", "name": "hardware variation design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001767", "default": false, "short_name": "hardware variation design", "image_url": "", "public": true }, { "id": "0daebfc8-9e5d-4664-bb4d-fec4ba0a021e", "name": "dye swap design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001765", "default": false, "short_name": "dye swap design", "image_url": "", "public": true }, { "id": "4c4c6334-5562-40fa-a83f-14bdca96d047", "name": "array platform variation design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001764", "default": false, "short_name": "array platform variation design", "image_url": "", "public": true }, { "id": "e3fe4c0e-ef10-408e-80e1-61e1ae211839", "name": "all pairs", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001763", "default": false, "short_name": "all pairs", "image_url": "", "public": true }, { "id": "e7d6b327-9d2b-4076-b517-8f0f1b104076", "name": "validation by real time PCR design", "description": "", "dbxref_id": "http://purl.obolibrary.org/obo/OBI_0001166", "default": false, "short_name": "validation by real time PCR design", "image_url": "", "public": true }, { "id": "0719d873-ef5e-478a-9f2a-3c98ea549b95", "name": "validation by reverse transcription PCR design", "description": "", "dbxref_id": "http://purl.obolibrary.org/obo/OBI_0001162", "default": false, "short_name": "validation by reverse transcription PCR design", "image_url": "", "public": true }, { "id": "27ebd9da-7fd5-4f50-a0b0-08ffcca7b5e6", "name": "cellular modification design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0004666", "default": false, "short_name": "cellular modification design", "image_url": "", "public": true }, { "id": "eee83d16-aeb9-4b71-93cc-7f5cf21b4814", "name": "clinical history design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001780", "default": false, "short_name": "clinical history design", "image_url": "", "public": true }, { "id": "35b9abc1-01bc-4d81-994c-876bf490c869", "name": "dose response design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001757", "default": false, "short_name": "dose response design", "image_url": "", "public": true }, { "id": "3a150378-347a-4186-a50a-fb192e99350f", "name": "disease state design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001756", "default": false, "short_name": "disease state design", "image_url": "", "public": true }, { "id": "64b6f876-aa49-48d7-be82-a17f11c220c3", "name": "compound treatment design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001755", "default": false, "short_name": "compound treatment design", "image_url": "", "public": true }, { "id": "62f51ec5-6c36-4cce-a88c-a8f9a304b3a1", "name": "development or differentiation design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001746", "default": false, "short_name": "development or differentiation design", "image_url": "", "public": true }, { "id": "b9ae21be-a7d9-4a7e-a40b-c2f69187517f", "name": "cell type comparison design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001745", "default": false, "short_name": "cell type comparison design", "image_url": "", "public": true }, { "id": "c3894fa6-643f-47cc-80e6-3fb8ff20feed", "name": "cell cycle design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001744", "default": false, "short_name": "cell cycle design", "image_url": "", "public": true }, { "id": "26824e13-bad0-44d0-a3fc-3c46dba88b58", "name": "cell component comparison design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001743", "default": false, "short_name": "cell component comparison design", "image_url": "", "public": true }, { "id": "63feccf6-f571-44b7-94d7-d3fd916ce4b1", "name": "family based design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001429", "default": false, "short_name": "family based design", "image_url": "", "public": true }, { "id": "5c773d3b-10ad-429f-b108-0f8730221e43", "name": "cross sectional design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001428", "default": false, "short_name": "cross sectional design", "image_url": "", "public": true }, { "id": "b33453d3-c761-4cdb-8fd9-8b42689fb320", "name": "case control design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001427", "default": false, "short_name": "case control design", "image_url": "", "public": true }, { "id": "11d083d9-ed7a-43dc-8ed1-d8015d330592", "name": "species design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001753", "default": false, "short_name": "species design", "image_url": "", "public": true }, { "id": "d1bd7d85-438e-45c3-84cc-a7124db6dc48", "name": "sex design", "description": "", "dbxref_id": "http://www.ebi.ac.uk/efo/EFO_0001752", "default": false, "short_name": "sex design", "image_url": "", "public": true } ] }, "permissions": { "name": "permissions", "value": { "public": true, "actions": { "view": { "users": [], "groups": [] }, "change": { "users": [], "groups": [] }, "delete": { "users": [], "groups": [] } }, "allowed": [ "view" ] }, "category": "property" }, "public": { "name": "public", "value": true, "category": "property" }, "owner": { "name": "owner", "value": { "id": 1, "username": "admin", "full_name": "Admin User" }, "category": "property" }, "owned_by": { "name": "owned_by", "value": { "id": 1, "name": "SYSTEM_GROUP" }, "category": "property" } } }