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/54268466-e543-4f08-baac-9919270c99c5/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/54268466-e543-4f08-baac-9919270c99c5/results/448310/?format=api",
            "id": 448310,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7d9779ab-7f50-4abc-91a6-93f17bd288b8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222639Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d4946ff7bc84563307d16a8ad04357a8dec8dfd01180db4217ea43bc4171fc99"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448311/?format=api",
            "id": 448311,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e09c09a5-153b-4680-ad7f-ba1db63cc26a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222639Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7636c37b1bb11f717c74d8a3a1942d44e1f421e6d17f00d561514f5286ad3e1a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448312/?format=api",
            "id": 448312,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bc5e715c-9b1c-495e-b4da-a405df08519c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222639Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a3425728cd75c64460bdcd942b21a71fd26bac4f434234535a0e768ad6cafa58"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448313/?format=api",
            "id": 448313,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/93989e96-a6c3-46aa-afc1-e41de135d564/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222639Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5e723e5db2bf7a9520bfa9e44a4be6a0ec67ad282f3020c4c6cbec10fb6d2aeb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448314/?format=api",
            "id": 448314,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5a163c94-b9f3-48cc-afb2-ac07b417a631/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222639Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=63c6ae4dc9a15b72d46d165bded7aeccd50337c9611c1a946d0c0a88cfb67280"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448315/?format=api",
            "id": 448315,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c05844f3-3636-4129-b023-06a0558675e1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222639Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=26dd50677dea2512048d86a455a1a1a735de533acdbd698b5f7f290f0261533f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448316/?format=api",
            "id": 448316,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/50c95d11-7648-48e3-b852-6bbe022b4b83/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222639Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=95310fe5d024f8ae7ae54682d7d1bfc3febde06a5d13a3ef7e3310272c18c233"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448317/?format=api",
            "id": 448317,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b4938c76-780e-4db2-981e-6813b05bb015/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222639Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=91dd7094e8ef4701b556d168fbd561ae51a30c67fc0d8b868e248f5646802867"
        }
    ]
}