Place List – Django REST framework

API endpoint that allows Locations to be viewed or edited.

» click to learn about Filtering, Ordering and more...

Accepted filters:

- name: Name starts with (istartswith)
- description: Description contains (icontains)
- query: Search filter on the name property (exact)
- deleted: Deleted (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 Locations to be viewed or edited.


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/places/?format=api&ordering=room

HTTP 200 OK
Allow: GET, POST, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "previous": null,
    "next": null,
    "current": 1,
    "total": 2,
    "total_pages": 1,
    "results": [
        {
            "id": "75f2afaf-c52d-425e-a65a-88167762a829",
            "created_by": "admin",
            "modified_by": "admin",
            "created": {
                "name": "created",
                "value": "2025-12-16T09:31:07.408873+01:00",
                "category": "property"
            },
            "modified": {
                "name": "modified",
                "value": "2025-12-16T09:31:07.408944+01:00",
                "category": "property"
            },
            "building": "",
            "room": "C1.70",
            "address": 1
        },
        {
            "id": "1ef195a3-7f14-4fd7-be16-9cf7adfe8006",
            "created_by": "admin",
            "modified_by": "admin",
            "created": {
                "name": "created",
                "value": "2025-12-16T09:31:07.478653+01:00",
                "category": "property"
            },
            "modified": {
                "name": "modified",
                "value": "2025-12-16T09:31:07.478797+01:00",
                "category": "property"
            },
            "building": "",
            "room": "C2.06",
            "address": 1
        }
    ]
}