Label Type List – Django REST framework

Endpoint for label types.

Query parameters

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

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

organisation__name: Related filter on organisation__name. Supports the following lookups: exact and startswith.

organisation__uuid: Related filter on organisation__uuid. Only support exact lookups.

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

access_modifier Filter on access_modifier, options are 'Public', 'Private', 'Common', or 'Hidden'.

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.

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

Examples

?name=Build year label

?name__startswith=Build

?description=Categorizes the building's build year

?description__startswith=Categorizes

?organisation__name__startswith=Nelen

?organisation__uuid=61f5a464-c350-44c1-9bc7-d4b42d7f58cb

?object_type__model=building

?access_modifier=Private

?access_modifier=100

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

?last_modified__lt=2018-01-01T00:00:00Z

Sub-endpoints

/labeltypes/{uuid}/compute/

/labeltypes/{uuid}/labels/

/labeltypes/{uuid}/labelparameters/

/labeltypes/{uuid}/template/

/labeltypes/{uuid}/visualise/

GET /api/v4/labeltypes/?format=api

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

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