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/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/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/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453478/?format=api",
            "id": 453478,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4cd036e4-c30c-4dcd-ba93-d568533f8d97/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T070253Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=74d150cc74a9c5fbdfce4ec03024fb42a9a289a5627fdf69ee87d5d8565df552"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453479/?format=api",
            "id": 453479,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/40a3f3fe-9cfa-479f-9cf5-21208c4819cd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T070253Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7a27df16cbede8b0fe6b559472035c3e72e421cc1cb63529fa6637a35a2bf078"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453480/?format=api",
            "id": 453480,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d6eb1b20-52a4-4c4c-beb5-e62ff2d02cb1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T070253Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=438878fc75c42a1460f9bcf0896b45d1b8885c7fcfa9bc219d68250d5f364d2e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453481/?format=api",
            "id": 453481,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/33785baf-8943-4bfd-9094-5c26135a6480/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T070253Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c40ab064d85a135017e0ebb14bdddc273056ba1ec67b83457c4996b8bc970634"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453482/?format=api",
            "id": 453482,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/93e54a3b-50b1-43fd-b1c5-bd524d3ead2f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T070253Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d055d91a806ef1cddc6668fe24b6b746a6e049f3132830f553d0229715f9f4aa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453483/?format=api",
            "id": 453483,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0a2447f5-027b-4599-b126-13daf57b2f64/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T070253Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=789ee8dd68f210bb4dbd0fa340ed0376ce309829071f3b1372a34ee937713269"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453484/?format=api",
            "id": 453484,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/725445ad-fcc1-4707-8150-98e4ae9b120e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T070253Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=030de4e8d41268f14681d3b201af405d306cc98841f9b38658b45f41e904bea2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453485/?format=api",
            "id": 453485,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/26beef29-9136-4c95-bc21-3fde47cce18a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T070253Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=772f202fb986fd866dd2d16531b896f3f878fcfdac241d8147519000cfe07396"
        }
    ]
}