Custom Property Type List
API endpoint that allows CustomProperties to be viewed or edited.
» 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)
- type: Type (exact)
- label: Label (exact)
- model_name: Model name (exact)
- mandatory: Mandatory (exact)
- created_by: Created by Username (exact)
- modified_by: Modified by Username (exact)
- model_type: Model type (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
- created_by: created_by__username
- modified_by: modified_by__username
- owner: owner__username
- owned_by: owned_by__name
- deleted: <function filter_deleted at 0x7f45063765f0>
- 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
API endpoint that allows CustomProperties to be viewed or edited.
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/custompropertytypes/?format=api&page=4
{ "previous": "https://labid-demo.embl.de/api/v2/custompropertytypes/?format=api&page=3", "next": null, "current": 4, "total": 67, "total_pages": 4, "results": [ { "url": "https://labid-demo.embl.de/api/v2/custompropertytypes/d601ae36-0ea1-4492-8c59-5a26836a9a52/?format=api", "id": "d601ae36-0ea1-4492-8c59-5a26836a9a52", "created_by": "admin", "modified_by": "admin", "created": { "name": "created", "value": "2025-12-16T09:31:32.002621+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-16T09:31:32.002711+01:00", "category": "property" }, "name": "stocks_antibody_isotype", "choice_label": "stocks_antibody_isotype", "description": "Isotype of this Antibody.", "public": false, "permissions": { "public": false, "actions": {} }, "unit_choices_api": null, "type": "VOCABULARYTERM", "label": "Isotype", "help_text": "Isotype of this Antibody.", "default": "", "has_default": false, "multiple": false, "is_protocol_parameter": false, "autocomplete": "", "searchable": true, "readonly": false, "sortable": true, "cv_category": "6a7a3dae-1092-4a46-b5dd-809e00aab5ae", "mandatory": true, "validations": [ { "name": "required", "arguments": [], "error_message": "This field is mandatory." } ], "visibility": "ALWAYS", "edit_visibility": "ALWAYS", "list_visibility": "OPTIONAL", "value_choices": null, "choices_value": "id", "choices_label": "label", "choices_api": "https://labid-demo.embl.de/api/v2/vocabularies/terms/?category_id=6a7a3dae-1092-4a46-b5dd-809e00aab5ae&fields=id%2Clabel&ordering=name&page_size=20&response_format=flat", "preferred_view_widget": "CVVIEW", "preferred_edit_widget": "CVEDIT", "preferred_list_widget": "CSVTEXT", "field_meta": "ad0a3aab-0680-4e2b-b943-987013ba376b", "model_name": "stocks.consumable", "model_type": "ANTIBODY", "owner": "admin", "owned_by": "SYSTEM_GROUP" }, { "url": "https://labid-demo.embl.de/api/v2/custompropertytypes/68be694c-b7ff-44ba-b6bf-baf7ec4eac7d/?format=api", "id": "68be694c-b7ff-44ba-b6bf-baf7ec4eac7d", "created_by": "admin", "modified_by": "admin", "created": { "name": "created", "value": "2025-12-16T09:31:31.994128+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-16T09:31:31.994256+01:00", "category": "property" }, "name": "stocks_antibody_ab_type", "choice_label": "stocks_antibody_ab_type", "description": "Indicates if this antibody is a primary or a secondary Ab.", "public": false, "permissions": { "public": false, "actions": {} }, "unit_choices_api": null, "type": "TEXT", "label": "Ab Type", "help_text": "Indicates if this antibody is a primary or a secondary Ab.", "default": "PRIMARY", "has_default": true, "multiple": false, "is_protocol_parameter": false, "autocomplete": "", "searchable": true, "readonly": false, "sortable": true, "cv_category": null, "mandatory": true, "validations": [ { "name": "required", "arguments": [], "error_message": "This field is mandatory." } ], "visibility": "ALWAYS", "edit_visibility": "ALWAYS", "list_visibility": "OPTIONAL", "value_choices": [ [ "PRIMARY", "PRIMARY" ], [ "SECONDARY", "SECONDARY" ] ], "choices_value": "id", "choices_label": "name", "choices_api": null, "preferred_view_widget": "SELECT", "preferred_edit_widget": "SELECT", "preferred_list_widget": "SELECT", "field_meta": "b9bb221d-f305-4530-aeb2-a316165b2417", "model_name": "stocks.consumable", "model_type": "ANTIBODY", "owner": "admin", "owned_by": "SYSTEM_GROUP" }, { "url": "https://labid-demo.embl.de/api/v2/custompropertytypes/2ea838f2-fad7-4d73-b892-7568b4465514/?format=api", "id": "2ea838f2-fad7-4d73-b892-7568b4465514", "created_by": "admin", "modified_by": "admin", "created": { "name": "created", "value": "2025-12-16T09:22:51.116976+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-16T09:22:51.117059+01:00", "category": "property" }, "name": "additional_film", "choice_label": "additional_film", "description": "", "public": false, "permissions": { "public": false, "actions": {} }, "unit_choices_api": null, "type": "VOCABULARYTERM", "label": "Additional Film", "help_text": "", "default": "", "has_default": false, "multiple": false, "is_protocol_parameter": false, "autocomplete": "", "searchable": true, "readonly": false, "sortable": true, "cv_category": "906c09a2-8534-4991-93f0-5037090c2f52", "mandatory": false, "validations": [], "visibility": "ALWAYS", "edit_visibility": "ALWAYS", "list_visibility": "ALWAYS", "value_choices": null, "choices_value": "id", "choices_label": "label", "choices_api": "https://labid-demo.embl.de/api/v2/vocabularies/terms/?category_id=906c09a2-8534-4991-93f0-5037090c2f52&fields=id%2Clabel&ordering=name&page_size=20&response_format=flat", "preferred_view_widget": "CVVIEW", "preferred_edit_widget": "CVEDIT", "preferred_list_widget": "CSVTEXT", "field_meta": "ad0a3aab-0680-4e2b-b943-987013ba376b", "model_name": "stocks.consumable", "model_type": "EMGRID", "owner": "admin", "owned_by": "SYSTEM_GROUP" }, { "url": "https://labid-demo.embl.de/api/v2/custompropertytypes/a672dce3-d5e0-42fa-8d27-02b8e3da4f5f/?format=api", "id": "a672dce3-d5e0-42fa-8d27-02b8e3da4f5f", "created_by": "admin", "modified_by": "admin", "created": { "name": "created", "value": "2025-12-16T09:22:51.111640+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-16T09:22:51.111734+01:00", "category": "property" }, "name": "hole_geometry", "choice_label": "hole_geometry", "description": "", "public": false, "permissions": { "public": false, "actions": {} }, "unit_choices_api": null, "type": "VOCABULARYTERM", "label": "Hole Geometry", "help_text": "", "default": "", "has_default": false, "multiple": false, "is_protocol_parameter": false, "autocomplete": "", "searchable": true, "readonly": false, "sortable": true, "cv_category": "922cedc4-ce3d-4b8f-995b-c8d44cebb82e", "mandatory": false, "validations": [], "visibility": "ALWAYS", "edit_visibility": "ALWAYS", "list_visibility": "ALWAYS", "value_choices": null, "choices_value": "id", "choices_label": "label", "choices_api": "https://labid-demo.embl.de/api/v2/vocabularies/terms/?category_id=922cedc4-ce3d-4b8f-995b-c8d44cebb82e&fields=id%2Clabel&ordering=name&page_size=20&response_format=flat", "preferred_view_widget": "CVVIEW", "preferred_edit_widget": "CVEDIT", "preferred_list_widget": "CSVTEXT", "field_meta": "ad0a3aab-0680-4e2b-b943-987013ba376b", "model_name": "stocks.consumable", "model_type": "EMGRID", "owner": "admin", "owned_by": "SYSTEM_GROUP" }, { "url": "https://labid-demo.embl.de/api/v2/custompropertytypes/bc9017bf-9684-4d6c-afcd-383e5a2c670a/?format=api", "id": "bc9017bf-9684-4d6c-afcd-383e5a2c670a", "created_by": "admin", "modified_by": "admin", "created": { "name": "created", "value": "2025-12-16T09:22:51.106313+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-16T09:22:51.106401+01:00", "category": "property" }, "name": "support_film", "choice_label": "support_film", "description": "", "public": false, "permissions": { "public": false, "actions": {} }, "unit_choices_api": null, "type": "VOCABULARYTERM", "label": "Support Film", "help_text": "", "default": "", "has_default": false, "multiple": false, "is_protocol_parameter": false, "autocomplete": "", "searchable": true, "readonly": false, "sortable": true, "cv_category": "2d488eb0-5d33-4255-9afe-8028114a9996", "mandatory": false, "validations": [], "visibility": "ALWAYS", "edit_visibility": "ALWAYS", "list_visibility": "ALWAYS", "value_choices": null, "choices_value": "id", "choices_label": "label", "choices_api": "https://labid-demo.embl.de/api/v2/vocabularies/terms/?category_id=2d488eb0-5d33-4255-9afe-8028114a9996&fields=id%2Clabel&ordering=name&page_size=20&response_format=flat", "preferred_view_widget": "CVVIEW", "preferred_edit_widget": "CVEDIT", "preferred_list_widget": "CSVTEXT", "field_meta": "ad0a3aab-0680-4e2b-b943-987013ba376b", "model_name": "stocks.consumable", "model_type": "EMGRID", "owner": "admin", "owned_by": "SYSTEM_GROUP" }, { "url": "https://labid-demo.embl.de/api/v2/custompropertytypes/906f9ca1-6081-47e1-9158-3341626d7ce3/?format=api", "id": "906f9ca1-6081-47e1-9158-3341626d7ce3", "created_by": "admin", "modified_by": "admin", "created": { "name": "created", "value": "2025-12-16T09:22:51.100751+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-16T09:22:51.100887+01:00", "category": "property" }, "name": "base_material", "choice_label": "base_material", "description": "", "public": false, "permissions": { "public": false, "actions": {} }, "unit_choices_api": null, "type": "VOCABULARYTERM", "label": "Base Material", "help_text": "", "default": "", "has_default": false, "multiple": false, "is_protocol_parameter": false, "autocomplete": "", "searchable": true, "readonly": false, "sortable": true, "cv_category": "f2e3ee3b-f454-4e35-81c7-357e7524b45e", "mandatory": false, "validations": [], "visibility": "ALWAYS", "edit_visibility": "ALWAYS", "list_visibility": "ALWAYS", "value_choices": null, "choices_value": "id", "choices_label": "label", "choices_api": "https://labid-demo.embl.de/api/v2/vocabularies/terms/?category_id=f2e3ee3b-f454-4e35-81c7-357e7524b45e&fields=id%2Clabel&ordering=name&page_size=20&response_format=flat", "preferred_view_widget": "CVVIEW", "preferred_edit_widget": "CVEDIT", "preferred_list_widget": "CSVTEXT", "field_meta": "ad0a3aab-0680-4e2b-b943-987013ba376b", "model_name": "stocks.consumable", "model_type": "EMGRID", "owner": "admin", "owned_by": "SYSTEM_GROUP" }, { "url": "https://labid-demo.embl.de/api/v2/custompropertytypes/3ffcf012-f369-46ef-9796-e7fd98f3f49d/?format=api", "id": "3ffcf012-f369-46ef-9796-e7fd98f3f49d", "created_by": "admin", "modified_by": "admin", "created": { "name": "created", "value": "2025-12-16T09:22:51.089400+01:00", "category": "property" }, "modified": { "name": "modified", "value": "2025-12-16T09:22:51.089603+01:00", "category": "property" }, "name": "mesh", "choice_label": "mesh", "description": "", "public": false, "permissions": { "public": false, "actions": {} }, "unit_choices_api": null, "type": "TEXT", "label": "Mesh", "help_text": "", "default": "", "has_default": false, "multiple": false, "is_protocol_parameter": false, "autocomplete": "", "searchable": true, "readonly": false, "sortable": true, "cv_category": null, "mandatory": false, "validations": [], "visibility": "ALWAYS", "edit_visibility": "ALWAYS", "list_visibility": "ALWAYS", "value_choices": null, "choices_value": "id", "choices_label": "name", "choices_api": null, "preferred_view_widget": "TEXT", "preferred_edit_widget": "TEXTINPUT", "preferred_list_widget": "TEXT", "field_meta": "ca1f6072-9c3a-4b1c-8e1c-14e53370e4f4", "model_name": "stocks.consumable", "model_type": "EMGRID", "owner": "admin", "owned_by": "SYSTEM_GROUP" } ] }