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/8c753345-b2c5-44fb-ab4f-715780371c9e/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/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448213/?format=api",
            "id": 448213,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b2d04957-57ae-4f8c-90ff-d08132862b17/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190814Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=124e154828ab975f69be4942b743d382a8ea64898ded10460969f2198080e835"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448214/?format=api",
            "id": 448214,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6fe9e7d6-464f-4b11-b9f8-ddd04f3da578/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190814Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7eef7cd410ca32f8172685ead93d2376e5b0fa2fcefdf4f37416ab71bbacef61"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448215/?format=api",
            "id": 448215,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e5a9ea7f-0259-4cd6-a2f8-a7eef79df411/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190814Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e40f360886be1331200f006ed19c864bb3eafea34bf5c21e1babff7656ee96a7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448216/?format=api",
            "id": 448216,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3fd546ae-c906-4595-bc3a-216e4181b9c6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190814Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b1242dac95675b826028952fdaf0f64389e93dfb695d308b56a4f21f7652fe01"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448217/?format=api",
            "id": 448217,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9964ebed-d7d2-4b7b-be4d-004643072d68/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190814Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8a85372341d93fba2599bd7424f7fcf5753145a5b85457d9a2476060361b275b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448218/?format=api",
            "id": 448218,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5f3680ff-84fa-435b-b117-be17c3bccca8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190814Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b7e3e3a78f6ee3622dbab5a1bf4b58bf1d449d1298cb09a7ee195ee0ac468e6c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448219/?format=api",
            "id": 448219,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4dfcfd29-9b1a-4c7e-bef8-88196ca362d0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190814Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e8e347e794bc8df8545253a8194406faa6bb12fe68c5429f3f4a10b9c38cb6bf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448220/?format=api",
            "id": 448220,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8beab65f-4c63-4995-b95c-cb01ba3f8a0c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190814Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c0073882624ea75c6e8b71748298611bde4771a7adafaeb3e7a1ab24ac61a0c2"
        }
    ]
}