Label Parameter List – Django REST framework

Endpoint for per-object parameters associated with a labeltype.

GET

Retrieving a paginated list of label parameters requires a GET request to a list URL: GET /api/v4/labeltypes//labelparameters/ Retrieving a single label parameter requires a GET request to a detail URL: GET /api/v4/labeltypes//labelparameters//

POST

Creating and a label parameter requires a POST request to a list URL: POST /api/v4/labeltypes//labelparameters/

DELETE

Deleting all label parameters requires a DELETE request on a list URL: DELETE /api/v4/labeltypes//labelparameters/ Query parameters (see below) may be used to control what label parameters get deleted, for example: DELETE /api/v4/labeltypes//labelparameters/?object_id=123 Deleting a single label parameter requires a DELETE request on a detail URL: DELETE /api/v4/labeltypes//labelparameters//

Query parameters

name Text filter on the name field. Supports the following lookups: exact and startswith.

object_type__model: Filter on the object type name of the labeled object (e.g. 'building')

object_id: Filter on the ID of the labeled object.

start/end: Temporal filter on start and end. Supports various lookup types. Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

valid_at: Per label_type and object, return the latest valid label parameter.

created: Temporal filter on created. Supports various lookup types (exact, lt, lte, gt, gte; created__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

Examples:

?name=parameter_name

?name__startswith=parameter

?object_type__model=building

?object_id=123

?start__gte=2019-01-01T02:03:04Z

?start__lte=2019-01-01T02:03:04Z

?end__gte=2019-01-01T02:03:04Z

?end__lte=2019-01-01T02:03:04Z

?end__lt=2019-01-02T02:03:04Z&start__gt=2019-01-01T02:03:04Z

?valid_at=2019-01-02T02:03:00Z

?created__gte=2017-01-01T00:00:00Z

GET /api/v4/labeltypes/e23c58ea-ae39-41bf-9867-021a996034b8/labelparameters/?format=api

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

{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}