Instrument Model Instance
None
» click to learn about Filtering, Ordering and more...
Accepted filters:
- 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)
- instrument_type: [invalid name] contains (icontains)
- platform: Platform (iexact)
- technology: Technology is in (in)
- 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={"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
- created_by: created_by__username
- modified_by: modified_by__username
- owner: owner__username
- owned_by: owned_by__name
- deleted: <function filter_deleted at 0x7f8cbd712440>
- deleted_by: deleted_by__username
- notes: notes__content
- cv_category: cv_category__name
- field_meta: field_meta__name
- mandatory_owned_by: mandatory_owned_by__name
- user: user__username
- workflowversion: workflowversion__name
- dataset: dataset__name
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
None 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/stocks/instrumentmodels/042227ee-4f82-4de4-8f6e-1f40f7859e50/?format=api&ordering=description
{ "results": { "url": { "name": "url", "value": "https://labid-demo.embl.de/api/v2/stocks/instrumentmodels/042227ee-4f82-4de4-8f6e-1f40f7859e50/?format=api", "category": "property" }, "id": { "name": "id", "category": "property", "value": "042227ee-4f82-4de4-8f6e-1f40f7859e50" }, "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:43:43.255966+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-02-18T21:43:43.256008+01:00", "category": "property" }, "model_name": { "name": "model_name", "category": "property", "value": "instrumentmodel" }, "app_name": { "name": "app_name", "category": "property", "value": "stocks" }, "model_type": { "name": "model_type", "category": "property", "value": "DEFAULT" }, "name": { "name": "name", "value": { "id": "042227ee-4f82-4de4-8f6e-1f40f7859e50", "name": "AVITI LT", "model_name": "instrumentmodel", "app_name": "stocks", "model_type": null }, "category": "property" }, "choice_label": { "name": "choice_label", "category": "property", "value": "AVITI LT" }, "description": { "name": "description", "category": "property", "value": "" }, "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" }, "technology": { "name": "technology", "value": { "value": "sequencing", "label": "sequencing" }, "category": "property" }, "platform": { "name": "platform", "category": "property", "value": "Element Biosciences" }, "public": { "name": "public", "value": true, "category": "property" }, "permissions": { "name": "permissions", "value": { "public": true, "actions": { "view": { "users": [ { "id": 2, "username": "admin", "email": "example-admin@embl.de", "is_active": true, "full_name": "admin" } ], "groups": [ { "id": 1, "name": "SYSTEM_GROUP" } ] }, "change": { "users": [ { "id": 2, "username": "admin", "email": "example-admin@embl.de", "is_active": true, "full_name": "admin" } ], "groups": [ { "id": 1, "name": "SYSTEM_GROUP" } ] }, "delete": { "users": [ { "id": 2, "username": "admin", "email": "example-admin@embl.de", "is_active": true, "full_name": "admin" } ], "groups": [] } }, "allowed": [ "change", "view" ] }, "category": "property" } } }