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/95efc565-7a7c-4eb2-ba58-43b789b544da/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/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448960/?format=api",
            "id": 448960,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7d5b3c6f-0016-4155-8040-345af950f7cb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164648Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a68d1e4811426f0d6354ba8fc12333a6cb7034dae649be55efe288c0f75a3b69"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448961/?format=api",
            "id": 448961,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9e340256-529b-4526-8600-e067ef94e7ab/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164648Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=54888ca18080a238b0188b42fc0ef687e372eda8aaec00c773cc20098d8b1a73"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448962/?format=api",
            "id": 448962,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/19b00bcf-92ee-428d-9301-97d89efab655/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164648Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fc4f04b7677742001b3e80c99cb8400cb0f772c78fd1dd0976001e428ddcf033"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448963/?format=api",
            "id": 448963,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ba410013-103f-4933-8716-3c9f04591e78/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164648Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6466bdc40eff8725c82c2d323c00f2d93b888898ccbc2f9f00f936f53b74104f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448964/?format=api",
            "id": 448964,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b2b2adca-5a3e-441e-8f1e-991b47a97f1e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164648Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=94235bc2d845742a9339be1dc06915865f8641e1f1f15f52a286785701cdd271"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448965/?format=api",
            "id": 448965,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7cdd0f14-1469-49f8-b732-87413e341b1d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164648Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f46b18d4d70290f702718dbadc80c3cb08fd8384dbaf4ec5c84010a709611cf1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448966/?format=api",
            "id": 448966,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3c1ca36e-386e-4de8-830b-89ae05f07b6e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164648Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e4df9232e4ed08b41b4af68e77df429720f5445ab5038fccfa51dabb05553622"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448967/?format=api",
            "id": 448967,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/792088ec-05c1-4cae-b1c7-8cb854d32aa3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164648Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f8258f181002736c89b5f7f9a3aac0a0ae65ccfc375294ce8fc6caf5c4af498e"
        }
    ]
}