Basic – Django REST framework

Endpoint for interacting with 3Di scenario results.

Add attachments to newly created results by uploading a file (using a PUT request) to the temporary upload_url of a result.

Subendpoints

The subendpoints below have been defined for convienience and may be used for viewing or deleting a specific class of results. They are also available via the "Extra Actions" button in the top-right corner when viewing a result list.

/api/v4/scenarios/{uuid}/results/arrival/
/api/v4/scenarios/{uuid}/results/basic/
/api/v4/scenarios/{uuid}/results/damage/
/api/v4/scenarios/{uuid}/results/raw/
/api/v4/scenarios/{uuid}/results/tiles/

For example, a DELETE request on /api/v4/scenarios/{uuid}/results/raw/ would schedule all raw results for deletion. This is more convenient than deleting results one by one via /api/v4/scenarios/{uuid}/results/{id}/.

GET /api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/basic/?format=api

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

{
    "count": 8,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449534/?format=api",
            "id": 449534,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/769d5a39-2718-4f37-9d8f-4b5a028d6726/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182506Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=072f137aa9f9c142d9c4cce7dcc6dbb8dff8b214144beac98cf6deec5363b4ba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449535/?format=api",
            "id": 449535,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/316e5365-c714-412f-9333-db3c5ee479be/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182506Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=93f4fa645b0fae52117e1aacb1b8d79f4aff7ba31f5beb051d9d99e9ea4e5961"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449536/?format=api",
            "id": 449536,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/20b313ec-8207-434d-a5a6-4963008f02af/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182506Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c1240f946bb617e47c6eb145d92591c7aa18ded54c8a5a582f2be3059d16cf07"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449537/?format=api",
            "id": 449537,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fa2de6d8-2063-4898-9a58-5fee778221c6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182506Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9641acc9335a69047c096688d6720d43ac5628e82de51735eab8e5165f285508"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449538/?format=api",
            "id": 449538,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/77aa13b4-5495-4d82-a18c-34447ebaebd7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182506Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3f9b06817c83f0affff485354778f24a332dd83b89af8336746faf1dda86268c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449539/?format=api",
            "id": 449539,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ffb75f28-d355-449f-a3d2-976dc5236341/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182506Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8fc35a49e70e4fc299e25281fd83c435ed45ed88c39955392a5715697178bb16"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449540/?format=api",
            "id": 449540,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/42bc17d1-cc49-4212-bdd9-4972720c0197/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182506Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f2561f5b73b12d9a427a309ac00943ae5afca7007e0a87ad7adb4c7421de6209"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449541/?format=api",
            "id": 449541,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bd5e1053-cb59-4358-a388-3f1035904bd1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182506Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c03ac53c4f36eecd69357065b2f94f5961ff60e5c34d79e288d7171807a9aab4"
        }
    ]
}