Storage Volume 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)
- 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)
- is_primary_volume: Primary volume (exact)
- created_by: Created by Username (exact)
- modified_by: Modified by Username (exact)
- base_path: Base path contains (icontains)
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
- created_by: created_by__username
- modified_by: modified_by__username
- owner: owner__username
- owned_by: owned_by__name
- deleted: <function filter_deleted at 0x7f0bca588c10>
- 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
- credential: credential__name
- workflowversion: workflowversion__name
- workflowrun: workflowrun__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
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/data_management/storagevolumes/6e3ecefa-cb3f-4d1e-ac87-0623df887c81/?format=api
{ "results": { "url": { "name": "url", "value": "https://labid-demo.embl.de/api/v2/data_management/storagevolumes/6e3ecefa-cb3f-4d1e-ac87-0623df887c81/?format=api", "category": "property" }, "id": { "name": "id", "category": "property", "value": "6e3ecefa-cb3f-4d1e-ac87-0623df887c81" }, "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-08T16:30:03.746705+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-08T16:30:03.747432+01:00", "category": "property" }, "model_name": { "name": "model_name", "category": "property", "value": "storagevolume" }, "app_name": { "name": "app_name", "category": "property", "value": "data_management" }, "model_type": { "name": "model_type", "category": "property", "value": "DEFAULT" }, "name": { "name": "name", "value": { "id": "6e3ecefa-cb3f-4d1e-ac87-0623df887c81", "name": "LocalArchive", "model_name": "storagevolume", "app_name": "data_management", "model_type": null }, "category": "property" }, "choice_label": { "name": "choice_label", "category": "property", "value": "LocalArchive" }, "description": { "name": "description", "category": "property", "value": "" }, "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" }, "is_primary_volume": { "name": "is_primary_volume", "value": false, "category": "property" }, "is_modifyable": { "name": "is_modifyable", "category": "property", "value": false }, "base_path": { "name": "base_path", "value": "/app/labid/storage/archiver", "category": "property" }, "endpoint_url": { "name": "endpoint_url", "value": "", "category": "property" }, "storage_time": { "name": "storage_time", "category": "property", "value": 0 }, "storage_time_unit": { "name": "storage_time_unit", "value": { "value": "WEEK", "label": "WEEK" }, "category": "property" }, "storagebackend": { "name": "storagebackend", "value": "ArchiveStorageBackend", "category": "property" }, "is_dropbox_volume": { "name": "is_dropbox_volume", "category": "property", "value": false }, "credential": { "name": "credential", "category": "property", "value": null } }, "storagebackend": "ArchiveStorageBackend" }