Endpoint for label types.

Query parameters

uuid: Text filter on uuid. Supports a comma-separated list of (fragments of) UUIDs. UUIDs must be specified in their canonical form (with hyphens, that is). Case insensitive. Only supports uuid__icontains, the default.

name: Text filter on name. Supports various lookup types (name__exact by default).

organisation: Related filter on organisation. Supports various lookups such as organisation__name__icontains.

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

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

Sub-endpoints

/api/v3/labeltypes/{uuid}/compute/

Calculates labels for the label type characterized by uuid. GET may be used to calculate a single, non-presistent label synchronously. Multiple, persistent labels can only be calculated asynchronously using POST. The following query parameters are supported:

start (optional): A combined ISO 8601 date and time representation, e.g. 2019-01-01T00:00:00Z. Defaults to now. Only objects are labeled that are valid at this time. Also defines the start of the label validity.

end (optional): A combined ISO 8601 date and time representation, e.g. 2020-01-01T00:00:00Z. Defines the end of the label validity.

object_id (optional): May be used to calculate a label for a single object, e.g. a specific building. See the buildings endpoint.

boundary_id (optional): Only calculate labels for objects within this boundary. See the regions endpoint.

geom_intersects (optional): Only calculate labels for objects that intersect with this geometry (WKT in WGS84 projection).

tile_size (optional): Use tiling for the label computation. Only available for async computations (POST requests)

tile_projection (optional): The projection (spatial reference) to perform tiling in. Default EPSG:4326 (WGS84).

skip_existing (optional): Whether to skip objects that already have a label of this label type valid at given start. Default false.

NB: Either object_id or boundary_id or geom_intersects has to be specified.

NB: The graph endpoint should have label_value and object_id columns set.

NB: No payload should be sent in case of POST.

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

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v3/labeltypes/e23c58ea-ae39-41bf-9867-021a996034b8/",
            "name": "floodlabel_uu",
            "description": "floodlabel uu",
            "uuid": "e23c58ea-ae39-41bf-9867-021a996034b8",
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/61f5a464c35044c19bc7d4b42d7f58cb/",
                "name": "Nelen & Schuurmans",
                "unique_id": "61f5a464c35044c19bc7d4b42d7f58cb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/61f5a464c35044c19bc7d4b42d7f58cb/users/"
            },
            "created": "2019-07-19T09:53:12.150550Z",
            "object_type": "building",
            "last_modified": "2019-12-10T11:07:06.871752Z",
            "source": {
                "graph": {
                    "SetSeriesBlock_0fe6a83ff39bb8adc60fe63d1b013a5e": [
                        "dask_geomodeling.geometry.base.SetSeriesBlock",
                        "GeoDjangoSource_f7dd72a50a80416c1ef04adc54f9c9cb",
                        "label",
                        "Classify_5dbe9de9fb2bc3fa3af297bb1d5aa1fb",
                        "label_value",
                        "Classify_5dbe9de9fb2bc3fa3af297bb1d5aa1fb",
                        "label_score",
                        "Add_3fd057b25c905ffbae2030d2cce824d5",
                        "fluvial_value",
                        "GetSeriesBlock_a837f387f358604fede17054496a3154",
                        "fluvial_score",
                        "Classify_8c353efce6477ce35ac3a2b18716960e",
                        "fluvial_label",
                        "Classify_17479f1c5af64cd59a0a7f8eb07a4f18",
                        "pluvial_value",
                        "GetSeriesBlock_b42c06a6f8979bd4fb4b7ebff10200db",
                        "pluvial_score",
                        "Classify_cf9e767c990c5bb7d20fd4105e902ac6",
                        "pluvial_label",
                        "Classify_74cb21ffd2bcb9927fb2b2d1c7c086f8",
                        "groundwater_value",
                        "GetSeriesBlock_00e3549e9b46389f2bc2119999bcc04a",
                        "groundwater_score",
                        "Classify_ea2904bc6c99b18759f2ea542e61fdc4",
                        "groundwater_label",
                        "Classify_bc2a2e1839df7a67269e5743010c56d1",
                        "sewage_score",
                        10,
                        "sewage_label",
                        "C"
                    ],
                    "Classify_8c353efce6477ce35ac3a2b18716960e": [
                        "dask_geomodeling.geometry.field_operations.Classify",
                        "GetSeriesBlock_a837f387f358604fede17054496a3154",
                        [
                            0.2,
                            0.5,
                            2,
                            5
                        ],
                        [
                            0,
                            5,
                            10,
                            15,
                            20
                        ],
                        false
                    ],
                    "Classify_5dbe9de9fb2bc3fa3af297bb1d5aa1fb": [
                        "dask_geomodeling.geometry.field_operations.Classify",
                        "Add_3fd057b25c905ffbae2030d2cce824d5",
                        [
                            16,
                            32,
                            48,
                            64
                        ],
                        [
                            "A",
                            "B",
                            "C",
                            "D",
                            "E"
                        ],
                        false
                    ],
                    "Classify_74cb21ffd2bcb9927fb2b2d1c7c086f8": [
                        "dask_geomodeling.geometry.field_operations.Classify",
                        "Classify_cf9e767c990c5bb7d20fd4105e902ac6",
                        [
                            5,
                            10,
                            15,
                            20
                        ],
                        [
                            "A",
                            "B",
                            "C",
                            "D",
                            "E"
                        ],
                        false
                    ],
                    "Add_3fd057b25c905ffbae2030d2cce824d5": [
                        "dask_geomodeling.geometry.field_operations.Add",
                        "Add_8938b3d326a01685b7098fdd3932014f",
                        "Classify_ea2904bc6c99b18759f2ea542e61fdc4"
                    ],
                    "Classify_cf9e767c990c5bb7d20fd4105e902ac6": [
                        "dask_geomodeling.geometry.field_operations.Classify",
                        "GetSeriesBlock_b42c06a6f8979bd4fb4b7ebff10200db",
                        [
                            0.05,
                            0.1,
                            0.15,
                            0.2
                        ],
                        [
                            0,
                            5,
                            10,
                            15,
                            20
                        ],
                        false
                    ],
                    "Classify_ea2904bc6c99b18759f2ea542e61fdc4": [
                        "dask_geomodeling.geometry.field_operations.Classify",
                        "GetSeriesBlock_00e3549e9b46389f2bc2119999bcc04a",
                        [
                            0.2,
                            0.4,
                            0.6,
                            0.8
                        ],
                        [
                            20,
                            15,
                            10,
                            5,
                            0
                        ],
                        false
                    ],
                    "GeoDjangoSource_f7dd72a50a80416c1ef04adc54f9c9cb": [
                        "django_geoblocks.blocks.sources.GeoDjangoSource",
                        "hydra_core",
                        "building",
                        {
                            "id": "object_id",
                            "code": "building_BAG_code"
                        },
                        "geometry",
                        "start",
                        "end",
                        {
                            "organisation__in": [
                                387,
                                388,
                                10,
                                280,
                                426,
                                434,
                                51,
                                439,
                                440,
                                314,
                                444,
                                446,
                                64,
                                449,
                                456,
                                77,
                                464,
                                81,
                                339,
                                469,
                                341,
                                474,
                                477,
                                356,
                                357,
                                359,
                                369,
                                118,
                                124
                            ]
                        }
                    ],
                    "GetSeriesBlock_b42c06a6f8979bd4fb4b7ebff10200db": [
                        "dask_geomodeling.geometry.base.GetSeriesBlock",
                        "AggregateRaster_ef7693ce556324b14a802f3a1388eef5",
                        "pluvial_max_value"
                    ],
                    "Classify_bc2a2e1839df7a67269e5743010c56d1": [
                        "dask_geomodeling.geometry.field_operations.Classify",
                        "Classify_ea2904bc6c99b18759f2ea542e61fdc4",
                        [
                            5,
                            10,
                            15,
                            20
                        ],
                        [
                            "A",
                            "B",
                            "C",
                            "D",
                            "E"
                        ],
                        false
                    ],
                    "GetSeriesBlock_00e3549e9b46389f2bc2119999bcc04a": [
                        "dask_geomodeling.geometry.base.GetSeriesBlock",
                        "AggregateRaster_25e91af250f23dd85d37fb2837b6fe56",
                        "groundwater_max_value"
                    ],
                    "GetSeriesBlock_a837f387f358604fede17054496a3154": [
                        "dask_geomodeling.geometry.base.GetSeriesBlock",
                        "AggregateRaster_c96aeebd9824f3ac4b71a2fa420a46ed",
                        "fluvial_max_value"
                    ],
                    "Classify_17479f1c5af64cd59a0a7f8eb07a4f18": [
                        "dask_geomodeling.geometry.field_operations.Classify",
                        "Classify_8c353efce6477ce35ac3a2b18716960e",
                        [
                            5,
                            10,
                            15,
                            20
                        ],
                        [
                            "A",
                            "B",
                            "C",
                            "D",
                            "E"
                        ],
                        false
                    ],
                    "Add_8938b3d326a01685b7098fdd3932014f": [
                        "dask_geomodeling.geometry.field_operations.Add",
                        "Add_9b0af83e56e506b9d37b2efa33971cdb",
                        10
                    ],
                    "AggregateRaster_ef7693ce556324b14a802f3a1388eef5": [
                        "dask_geomodeling.geometry.aggregate.AggregateRaster",
                        "GeoDjangoSource_f7dd72a50a80416c1ef04adc54f9c9cb",
                        "FillNoData_00945900efb7b6fe74b06c27ef7afef2",
                        "max",
                        "epsg:28992",
                        1.0,
                        null,
                        "pluvial_max_value",
                        false
                    ],
                    "AggregateRaster_25e91af250f23dd85d37fb2837b6fe56": [
                        "dask_geomodeling.geometry.aggregate.AggregateRaster",
                        "GeoDjangoSource_f7dd72a50a80416c1ef04adc54f9c9cb",
                        "LizardRasterSource_12e9dfd21be0048352a83cce2c887d7f",
                        "max",
                        "epsg:28992",
                        1.0,
                        null,
                        "groundwater_max_value",
                        false
                    ],
                    "AggregateRaster_c96aeebd9824f3ac4b71a2fa420a46ed": [
                        "dask_geomodeling.geometry.aggregate.AggregateRaster",
                        "GeoDjangoSource_f7dd72a50a80416c1ef04adc54f9c9cb",
                        "FillNoData_c48e633c9799b352b2c0e9a88832089a",
                        "max",
                        "epsg:28992",
                        1.0,
                        null,
                        "fluvial_max_value",
                        false
                    ],
                    "Add_9b0af83e56e506b9d37b2efa33971cdb": [
                        "dask_geomodeling.geometry.field_operations.Add",
                        "Classify_8c353efce6477ce35ac3a2b18716960e",
                        "Classify_cf9e767c990c5bb7d20fd4105e902ac6"
                    ],
                    "FillNoData_00945900efb7b6fe74b06c27ef7afef2": [
                        "dask_geomodeling.raster.elemwise.FillNoData",
                        "IsData_9b25dc5d6c4ba10b1485b3c646d6e5f2",
                        "LizardRasterSource_1ba9bfb39cbfc30c25028c98a0adb86d"
                    ],
                    "LizardRasterSource_12e9dfd21be0048352a83cce2c887d7f": [
                        "lizard_nxt.blocks.LizardRasterSource",
                        "12347f92-7db2-4ac0-92e1-850bb8b7625e"
                    ],
                    "FillNoData_c48e633c9799b352b2c0e9a88832089a": [
                        "dask_geomodeling.raster.elemwise.FillNoData",
                        "IsData_dc5265b97eb071d557fbdef67212b9d6",
                        "LizardRasterSource_8c6cd26bc66fb3045da0658bb24c1aea"
                    ],
                    "IsData_9b25dc5d6c4ba10b1485b3c646d6e5f2": [
                        "dask_geomodeling.raster.elemwise.IsData",
                        "LizardRasterSource_1ba9bfb39cbfc30c25028c98a0adb86d"
                    ],
                    "LizardRasterSource_1ba9bfb39cbfc30c25028c98a0adb86d": [
                        "lizard_nxt.blocks.LizardRasterSource",
                        "7832c65e-0ef5-47cb-9ad6-ba99ef46f4c4"
                    ],
                    "IsData_dc5265b97eb071d557fbdef67212b9d6": [
                        "dask_geomodeling.raster.elemwise.IsData",
                        "LizardRasterSource_8c6cd26bc66fb3045da0658bb24c1aea"
                    ],
                    "LizardRasterSource_8c6cd26bc66fb3045da0658bb24c1aea": [
                        "lizard_nxt.blocks.LizardRasterSource",
                        "bf9c373a-604e-4b1a-9ca5-fd1be6d5c419"
                    ]
                },
                "name": "SetSeriesBlock_0fe6a83ff39bb8adc60fe63d1b013a5e",
                "url": "https://demo.lizard.net/api/v3/geoblocks/f5c575d9-e742-4120-9bf3-bbdc83e625d3/"
            },
            "access_modifier": "Public"
        }
    ]
}