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/d303173d-9622-40f0-a1d2-fdc121f43aea/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/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449632/?format=api",
            "id": 449632,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/787bf3e1-c820-4154-bee9-f50d7c1075d9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111458Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eeddb6b34eea0d3eebb6ab8c8cacd05786b6db516f1e102a695a915b2f355b33"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449633/?format=api",
            "id": 449633,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8c4a9a13-015f-4f28-8bef-dfdaab0b5346/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111458Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f1fb4c3701dc82bdfa6f3822b1126f3c0e2cbdaf882f521fb3a387e77b272569"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449634/?format=api",
            "id": 449634,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/17f4de54-9de6-4abc-a1ca-9ff22be2ef1f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111458Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=efeb0b109376606604d40949329f80368132e9621dc9b54b2631bacb6dd05e3f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449635/?format=api",
            "id": 449635,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f7f8fd7c-098a-47cb-ba85-59ce8b962802/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111458Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5b49c2ac61e3827f958e8ac99b0b80cf6be2258fd5fdeb716cc9fd9d17f64478"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449636/?format=api",
            "id": 449636,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d3f75887-6e89-4c2f-804c-f37f20789739/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111458Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1739ddf0fb3087f5b5ce0e581069f0ffe51912604425ca86b94b8f0ebc1a82ec"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449637/?format=api",
            "id": 449637,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8e3c0dcd-e37e-4fd5-8f29-ded342acc869/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111458Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2aa3403bbe9b8878388de00269d1a1d6add2117a4936d837b249571d43c2602f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449638/?format=api",
            "id": 449638,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c62a382f-8b77-4837-9c28-2294bcfb40b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111458Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cfce4d009706bc13dec355f561da3eaebcd587c83ec4e10ba6ec463d97c8ec25"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449639/?format=api",
            "id": 449639,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6ed2ad38-1015-4256-ad14-76ae2fe503d9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111458Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=42813acf941a5cd43a3341495dc2de7af37a722ecd1e98bec5f076e789621bf9"
        }
    ]
}