Term List
API endpoint that allows CV Terms to be viewed or edited.
» click to learn about Filtering, Ordering and more...
Accepted filters:
- search: Search in the following fields: ^name, ^description. (^startswith, $regex, =exact)
- id: ID (exact)
- created: Created (exact)
- modified: Modified (exact)
- name: Name starts with (istartswith)
- description: Description contains (icontains)
- autocomplete: Autocomplete 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)
- default: Default (exact)
- category__name: Category Name (exact)
- category__id: Category ID (exact)
- created_by: Created by Username (exact)
- modified_by: Modified by Username (exact)
- dbxref_id: DBXRef ID (exact)
- category_name: Filter on category name (exact)
- category: Filter by category id (exact)
- category_id: Filter by category id (exact)
- category_id_list: Filter on list of category ids [OR] (exact)
- category_name_list: Filter on list of category names [OR] (exact)
» more..
- property: A property for which we need to retrieve the available terms, can be a name or uuid
- dependencies: a json dict that has the values for the properties the given property depends on:
{"chemical_risk_code": "R1", "<uuid>": "H1"}
- intersect: default False, Intersect on the given filter values instead of doing a "ANY" lookup
- scope(_id): (multiple) name or uuid of one or more Scopes.
- scope_tag(_id): (multiple) name or uuid of one or more Scope Tags.
Multiple scopes or scope tags are given like so: scope=Scope1&scope=Scope2
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={"category":"name","operator":"contains","value":"Y00"},
{"category":"amount","operator":">","value":"10"},
{"category":"type__name","operator":"exact","value":"ANTIBODY"}
» more info about the query param..
Preset mappings
- category: category__name
- deleted: <function filter_deleted at 0x7f8cbd712440>
- 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 Terms to be viewed or edited.
<details>
<summary>
<i> » click to learn about Filtering, Ordering and more...</i>
</summary>
<details>
<summary> » more..</summary>
```
- property: A property for which we need to retrieve the available terms, can be a name or uuid
- dependencies: a json dict that has the values for the properties the given property depends on:
{"chemical_risk_code": "R1", "<uuid>": "H1"}
- intersect: default False, Intersect on the given filter values instead of doing a "ANY" lookup
- scope(_id): (multiple) name or uuid of one or more Scopes.
- scope_tag(_id): (multiple) name or uuid of one or more Scope Tags.
Multiple scopes or scope tags are given like so: scope=Scope1&scope=Scope2
```
</details>
</details>
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/terms/?format=api&ordering=-public&page=2
{ "previous": "https://labid-demo.embl.de/api/v2/vocabularies/terms/?format=api&ordering=-public", "next": "https://labid-demo.embl.de/api/v2/vocabularies/terms/?format=api&ordering=-public&page=3", "current": 2, "total": 618, "total_pages": 124, "results": [ { "url": { "name": "url", "value": "https://labid-demo.embl.de/api/v2/vocabularies/terms/e8bcb4f8-afbd-4f4a-878d-48d6fb989b02/?format=api", "category": "property" }, "id": { "name": "id", "category": "property", "value": "e8bcb4f8-afbd-4f4a-878d-48d6fb989b02" }, "created_by": { "name": "created_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "modified_by": { "name": "modified_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "created": { "name": "created", "value": "2025-02-18T21:41:16.539582+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-02-18T21:41:16.541052+01:00", "category": "property" }, "model_name": { "name": "model_name", "category": "property", "value": "term" }, "app_name": { "name": "app_name", "category": "property", "value": "vocabularies" }, "model_type": { "name": "model_type", "category": "property", "value": "DEFAULT" }, "name": { "name": "name", "value": { "id": "e8bcb4f8-afbd-4f4a-878d-48d6fb989b02", "name": "Fruit Fly", "model_name": "term", "app_name": "vocabularies", "model_type": null }, "category": "property" }, "choice_label": { "name": "choice_label", "category": "property", "value": "Fruit Fly" }, "description": { "name": "description", "category": "property", "value": "Drosophila" }, "label": { "name": "label", "category": "property", "value": "Fruit Fly (Drosophila)" }, "short_name": { "name": "short_name", "category": "property", "value": "Fruit Fly" }, "image_url": { "name": "image_url", "category": "property", "value": "" }, "category": { "name": "category", "value": { "id": "a07b15f3-8e56-4c15-96c8-21cc048dc528", "name": "species", "label": "Species", "deleted": false, "model_name": "category", "app_name": "vocabularies", "model_type": "DEFAULT" }, "category": "property" }, "dbxref_id": { "name": "dbxref_id", "category": "property", "value": "Drosophila" }, "default": { "name": "default", "category": "property", "value": false }, "permissions": { "name": "permissions", "value": { "public": true, "actions": {}, "allowed": [ "view" ] }, "category": "property" }, "public": { "name": "public", "value": true, "category": "property" }, "owner": { "name": "owner", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "owned_by": { "name": "owned_by", "value": { "id": 1, "name": "SYSTEM_GROUP" }, "category": "property" } }, { "url": { "name": "url", "value": "https://labid-demo.embl.de/api/v2/vocabularies/terms/9b6fa1dd-e046-474a-a27c-a2d4b9a1deea/?format=api", "category": "property" }, "id": { "name": "id", "category": "property", "value": "9b6fa1dd-e046-474a-a27c-a2d4b9a1deea" }, "created_by": { "name": "created_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "modified_by": { "name": "modified_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "created": { "name": "created", "value": "2025-02-18T21:41:16.571335+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-02-18T21:41:16.585991+01:00", "category": "property" }, "model_name": { "name": "model_name", "category": "property", "value": "term" }, "app_name": { "name": "app_name", "category": "property", "value": "vocabularies" }, "model_type": { "name": "model_type", "category": "property", "value": "DEFAULT" }, "name": { "name": "name", "value": { "id": "9b6fa1dd-e046-474a-a27c-a2d4b9a1deea", "name": "E. coli", "model_name": "term", "app_name": "vocabularies", "model_type": null }, "category": "property" }, "choice_label": { "name": "choice_label", "category": "property", "value": "E. coli" }, "description": { "name": "description", "category": "property", "value": "Escherichia coli" }, "label": { "name": "label", "category": "property", "value": "E. coli (Escherichia coli)" }, "short_name": { "name": "short_name", "category": "property", "value": "E. coli" }, "image_url": { "name": "image_url", "category": "property", "value": "" }, "category": { "name": "category", "value": { "id": "a07b15f3-8e56-4c15-96c8-21cc048dc528", "name": "species", "label": "Species", "deleted": false, "model_name": "category", "app_name": "vocabularies", "model_type": "DEFAULT" }, "category": "property" }, "dbxref_id": { "name": "dbxref_id", "category": "property", "value": "Escherichia coli" }, "default": { "name": "default", "category": "property", "value": false }, "permissions": { "name": "permissions", "value": { "public": true, "actions": {}, "allowed": [ "view" ] }, "category": "property" }, "public": { "name": "public", "value": true, "category": "property" }, "owner": { "name": "owner", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "owned_by": { "name": "owned_by", "value": { "id": 1, "name": "SYSTEM_GROUP" }, "category": "property" } }, { "url": { "name": "url", "value": "https://labid-demo.embl.de/api/v2/vocabularies/terms/cf8125c6-204b-46c8-9880-49a50f05d540/?format=api", "category": "property" }, "id": { "name": "id", "category": "property", "value": "cf8125c6-204b-46c8-9880-49a50f05d540" }, "created_by": { "name": "created_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "modified_by": { "name": "modified_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "created": { "name": "created", "value": "2025-02-18T21:41:16.618428+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-02-18T21:41:16.619997+01:00", "category": "property" }, "model_name": { "name": "model_name", "category": "property", "value": "term" }, "app_name": { "name": "app_name", "category": "property", "value": "vocabularies" }, "model_type": { "name": "model_type", "category": "property", "value": "DEFAULT" }, "name": { "name": "name", "value": { "id": "cf8125c6-204b-46c8-9880-49a50f05d540", "name": "Salmonella tm", "model_name": "term", "app_name": "vocabularies", "model_type": null }, "category": "property" }, "choice_label": { "name": "choice_label", "category": "property", "value": "Salmonella tm" }, "description": { "name": "description", "category": "property", "value": "Salmonella enterica serovar typhimurium" }, "label": { "name": "label", "category": "property", "value": "Salmonella tm (Salmonella enterica serovar typhimurium)" }, "short_name": { "name": "short_name", "category": "property", "value": "Salmonella tm" }, "image_url": { "name": "image_url", "category": "property", "value": "" }, "category": { "name": "category", "value": { "id": "a07b15f3-8e56-4c15-96c8-21cc048dc528", "name": "species", "label": "Species", "deleted": false, "model_name": "category", "app_name": "vocabularies", "model_type": "DEFAULT" }, "category": "property" }, "dbxref_id": { "name": "dbxref_id", "category": "property", "value": "Salmonella enterica serovar typhimurium" }, "default": { "name": "default", "category": "property", "value": false }, "permissions": { "name": "permissions", "value": { "public": true, "actions": {}, "allowed": [ "view" ] }, "category": "property" }, "public": { "name": "public", "value": true, "category": "property" }, "owner": { "name": "owner", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "owned_by": { "name": "owned_by", "value": { "id": 1, "name": "SYSTEM_GROUP" }, "category": "property" } }, { "url": { "name": "url", "value": "https://labid-demo.embl.de/api/v2/vocabularies/terms/9dd7f370-a63a-4fee-a440-d1340b0e34ef/?format=api", "category": "property" }, "id": { "name": "id", "category": "property", "value": "9dd7f370-a63a-4fee-a440-d1340b0e34ef" }, "created_by": { "name": "created_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "modified_by": { "name": "modified_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "created": { "name": "created", "value": "2025-02-18T21:41:16.650358+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-02-18T21:41:16.652200+01:00", "category": "property" }, "model_name": { "name": "model_name", "category": "property", "value": "term" }, "app_name": { "name": "app_name", "category": "property", "value": "vocabularies" }, "model_type": { "name": "model_type", "category": "property", "value": "DEFAULT" }, "name": { "name": "name", "value": { "id": "9dd7f370-a63a-4fee-a440-d1340b0e34ef", "name": "Chicken", "model_name": "term", "app_name": "vocabularies", "model_type": null }, "category": "property" }, "choice_label": { "name": "choice_label", "category": "property", "value": "Chicken" }, "description": { "name": "description", "category": "property", "value": "Gallus gallus" }, "label": { "name": "label", "category": "property", "value": "Chicken (Gallus gallus)" }, "short_name": { "name": "short_name", "category": "property", "value": "Chicken" }, "image_url": { "name": "image_url", "category": "property", "value": "" }, "category": { "name": "category", "value": { "id": "a07b15f3-8e56-4c15-96c8-21cc048dc528", "name": "species", "label": "Species", "deleted": false, "model_name": "category", "app_name": "vocabularies", "model_type": "DEFAULT" }, "category": "property" }, "dbxref_id": { "name": "dbxref_id", "category": "property", "value": "Gallus gallus" }, "default": { "name": "default", "category": "property", "value": false }, "permissions": { "name": "permissions", "value": { "public": true, "actions": {}, "allowed": [ "view" ] }, "category": "property" }, "public": { "name": "public", "value": true, "category": "property" }, "owner": { "name": "owner", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "owned_by": { "name": "owned_by", "value": { "id": 1, "name": "SYSTEM_GROUP" }, "category": "property" } }, { "url": { "name": "url", "value": "https://labid-demo.embl.de/api/v2/vocabularies/terms/04f26bfd-124e-4090-a3fb-f3e659eafb6a/?format=api", "category": "property" }, "id": { "name": "id", "category": "property", "value": "04f26bfd-124e-4090-a3fb-f3e659eafb6a" }, "created_by": { "name": "created_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "modified_by": { "name": "modified_by", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "created": { "name": "created", "value": "2025-02-18T21:41:16.320041+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-02-18T21:41:16.323837+01:00", "category": "property" }, "model_name": { "name": "model_name", "category": "property", "value": "term" }, "app_name": { "name": "app_name", "category": "property", "value": "vocabularies" }, "model_type": { "name": "model_type", "category": "property", "value": "DEFAULT" }, "name": { "name": "name", "value": { "id": "04f26bfd-124e-4090-a3fb-f3e659eafb6a", "name": "unknown", "model_name": "term", "app_name": "vocabularies", "model_type": null }, "category": "property" }, "choice_label": { "name": "choice_label", "category": "property", "value": "unknown" }, "description": { "name": "description", "category": "property", "value": "" }, "label": { "name": "label", "category": "property", "value": "unknown" }, "short_name": { "name": "short_name", "category": "property", "value": "unknown" }, "image_url": { "name": "image_url", "category": "property", "value": "" }, "category": { "name": "category", "value": { "id": "a07b15f3-8e56-4c15-96c8-21cc048dc528", "name": "species", "label": "Species", "deleted": false, "model_name": "category", "app_name": "vocabularies", "model_type": "DEFAULT" }, "category": "property" }, "dbxref_id": { "name": "dbxref_id", "category": "property", "value": "unknown" }, "default": { "name": "default", "category": "property", "value": true }, "permissions": { "name": "permissions", "value": { "public": true, "actions": {}, "allowed": [ "view" ] }, "category": "property" }, "public": { "name": "public", "value": true, "category": "property" }, "owner": { "name": "owner", "value": { "id": 2, "username": "admin", "full_name": "admin" }, "category": "property" }, "owned_by": { "name": "owned_by", "value": { "id": 1, "name": "SYSTEM_GROUP" }, "category": "property" } } ] }