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/098696ce-c0b4-4536-a846-53f64d57fa1c/?format=api&ordering=owner
{ "results": { "url": { "name": "url", "value": "https://labid-demo.embl.de/api/v2/vocabularies/categories/098696ce-c0b4-4536-a846-53f64d57fa1c/?format=api", "category": "property" }, "id": { "name": "id", "category": "property", "value": "098696ce-c0b4-4536-a846-53f64d57fa1c" }, "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:23:19.296499+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-16T09:23:19.296574+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": "098696ce-c0b4-4536-a846-53f64d57fa1c", "name": "imaging_methods", "model_name": "category", "app_name": "vocabularies", "model_type": null }, "category": "property" }, "choice_label": { "name": "choice_label", "category": "property", "value": "imaging_methods" }, "description": { "name": "description", "category": "property", "value": "Imaging methods, http://purl.obolibrary.org/obo/fbbi.owl" }, "label": { "name": "label", "category": "property", "value": "Imaging_Methods" }, "status": { "name": "status", "value": { "value": "ACTIVE", "label": "Active" }, "category": "property" }, "source": { "name": "source", "category": "property", "value": "" }, "version": { "name": "version", "category": "property", "value": "2020-11-06" }, "terms": { "name": "terms", "category": "property", "value": [ { "id": "2e55c02e-a8bb-42d3-956e-d140a2d619ac", "name": "Other", "description": "", "dbxref_id": "Other", "default": false, "short_name": "Other", "image_url": "", "public": true }, { "id": "9399863f-f7ab-40f1-9dda-9abda21d051a", "name": "two-photon laser scanning microscopy", "description": "", "dbxref_id": "FBbi:00000254", "default": false, "short_name": "two-photon laser scanning microscopy", "image_url": "", "public": true }, { "id": "a70d78ba-4f8a-4fc4-9eec-3836539d3dde", "name": "multi-photon microscopy", "description": "", "dbxref_id": "FBbi:00000255", "default": false, "short_name": "multi-photon microscopy", "image_url": "", "public": true }, { "id": "66a427a5-dda5-4b4a-a9bf-4e1b6f024986", "name": "fluorescence polarization microscopy", "description": "", "dbxref_id": "FBbi:00000603", "default": false, "short_name": "fluorescence polarization microscopy", "image_url": "", "public": true }, { "id": "c4c1cfde-1eae-4151-8a84-10737f2bac0c", "name": "evanescent wave microscopy", "description": "", "dbxref_id": "FBbi:00000617", "default": false, "short_name": "evanescent wave microscopy", "image_url": "", "public": true }, { "id": "7e2decb3-687b-490a-8ce4-8e3496eae286", "name": "spinning disk confocal microscopy", "description": "", "dbxref_id": "FBbi:00000253", "default": false, "short_name": "spinning disk confocal microscopy", "image_url": "", "public": true }, { "id": "aeb74a0e-0912-4af7-b008-f5ed74d499ab", "name": "slit-scan confocal microscopy", "description": "", "dbxref_id": "FBbi:00000392", "default": false, "short_name": "slit-scan confocal microscopy", "image_url": "", "public": true }, { "id": "da6f36de-156f-4567-bc23-41e831b337e2", "name": "single-spot confocal microscopy", "description": "", "dbxref_id": "FBbi:00000252", "default": false, "short_name": "single-spot confocal microscopy", "image_url": "", "public": true }, { "id": "1fdcd417-98cc-469a-927c-6a37b0641d69", "name": "array-scan confocal microscopy", "description": "Fixed array of sources focused to an array of spots that is swept over the specimen in raster fashion", "dbxref_id": "FBbi:00000393", "default": false, "short_name": "array-scan confocal microscopy", "image_url": "", "public": true }, { "id": "a9446f5d-96c8-4cee-8df5-afcbd12b2d97", "name": "confocal microscopy", "description": "", "dbxref_id": "FBbi:00000251", "default": false, "short_name": "confocal microscopy", "image_url": "", "public": true }, { "id": "dd1c6b1b-7281-417c-901f-7dd57b36fa3a", "name": "SPIM", "description": "single (or selective) plane illumination", "dbxref_id": "FBbi:00000369", "default": false, "short_name": "SPIM", "image_url": "", "public": true }, { "id": "6bab622f-d4d8-4854-8179-66ac1273a6bf", "name": "FRET", "description": "Fluorescence (or Forster) resonance energy transfer; a method of estimating the distance between two fluorophores by measuring the extent of non-radiative energy transfer between the two. Experimentally, this involves selective excitation of one while observing emission from the other.", "dbxref_id": "FBbi:00000367", "default": false, "short_name": "FRET", "image_url": "", "public": true }, { "id": "0a974c0f-7616-4d87-9f25-c20b09796e84", "name": "FRAP", "description": "Fluorescence loss in photobleaching; a method of determining the rate and extent of exchange between a localized population of fluorophore and a non-localized diffusible pool, by observing the rate of recovery of brightness of the localized population after photobleaching.", "dbxref_id": "FBbi:00000366", "default": false, "short_name": "FRAP", "image_url": "", "public": true }, { "id": "469eb2cd-ed0d-4f77-9373-494880f73630", "name": "FLIP", "description": "Fluorescence loss in photobleaching; a method of determining whether two populations of fluorophore are in diffusive communication with one another by observing the decrease in brightness of one population when the other population is subjected to continuous photobleaching.", "dbxref_id": "FBbi:00000365", "default": false, "short_name": "FLIP", "image_url": "", "public": true }, { "id": "c145981b-7105-45f6-8505-d43c636e82ea", "name": "FLIM", "description": "", "dbxref_id": "FBbi:00000368", "default": false, "short_name": "FLIM", "image_url": "", "public": true }, { "id": "a3a24fc4-9b87-45b8-899c-a28b45e7850c", "name": "fluorescence microscopy", "description": "", "dbxref_id": "FBbi:00000246", "default": false, "short_name": "fluorescence microscopy", "image_url": "", "public": true }, { "id": "7b9653c0-9793-41bc-a1f6-dfe60814f03c", "name": "orientation-independent polarization microscopy", "description": "", "dbxref_id": "FBbi:00000351", "default": false, "short_name": "orientation-independent polarization microscopy", "image_url": "", "public": true }, { "id": "db7f88f8-9bca-4f65-a45c-72028a90a7a8", "name": "polarization microscopy", "description": "", "dbxref_id": "FBbi:00000248", "default": false, "short_name": "polarization microscopy", "image_url": "", "public": true }, { "id": "950dbec5-a829-4eff-8117-10e03e597513", "name": "time lapse microscopy", "description": "", "dbxref_id": "FBbi:00000249", "default": false, "short_name": "time lapse microscopy", "image_url": "", "public": true }, { "id": "d743fe8d-a045-4dbe-83a7-96bbe612b9f5", "name": "phase contrast microscopy", "description": "", "dbxref_id": "FBbi:00000247", "default": false, "short_name": "phase contrast microscopy", "image_url": "", "public": true }, { "id": "2bba082d-332d-41ec-99fa-aff2f7f5d69f", "name": "differential interference contrast microscopy", "description": "", "dbxref_id": "FBbi:00000245", "default": false, "short_name": "differential interference contrast microscopy", "image_url": "", "public": true }, { "id": "c2b89103-01b2-4370-9691-21755d171fca", "name": "evanescent wave scattering", "description": "sub-type of dark-field microscopy", "dbxref_id": "FBbi:00000616", "default": false, "short_name": "evanescent wave scattering", "image_url": "", "public": true }, { "id": "463dde0b-423a-432c-a606-dad3293ada87", "name": "dark-field microscopy", "description": "imaging with rejection of the unscattered illumination (removal of the zero order component of the diffracted wave)", "dbxref_id": "FBbi:00000244", "default": false, "short_name": "dark-field microscopy", "image_url": "", "public": true }, { "id": "61de5f0d-95c3-4b99-91a3-45deede2ad83", "name": "bright-field microscopy", "description": "", "dbxref_id": "FBbi:00000243", "default": false, "short_name": "bright-field microscopy", "image_url": "", "public": true }, { "id": "46ae7bc9-b3f1-40ae-a606-6329f3b6ea70", "name": "OCT", "description": "optical coherence tomography; an interferometric method of imaging using back-scattered photons (elastic scattering)", "dbxref_id": "FBbi:00000371", "default": false, "short_name": "OCT", "image_url": "", "public": true }, { "id": "a2009cc6-80f8-44c2-8516-8b9da28e565b", "name": "CARS", "description": "coherent Raman anti-Stokes microscopy", "dbxref_id": "FBbi:00000370", "default": false, "short_name": "CARS", "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" } } }