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/1d895334-6aca-4445-9fc4-00d500ff4a03/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/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477626/?format=api",
            "id": 477626,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/84c9d592-be4e-4f53-b9a5-b78bb96439db/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142443Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c1776b1cff46cdc0e39f09a51dad2a1624179c7008cd2a6ba24e858494e27f04"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477627/?format=api",
            "id": 477627,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3a50e1fa-ef1c-455e-99d9-a9955e181897/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142443Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1af666a99de610bbb6225870d2b7f2b886c948ecf1241275064fdd9ee3546ed1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477628/?format=api",
            "id": 477628,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c61f570c-2e04-4457-9423-10b8e5171db4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142443Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0329d0e33a6ece5b150002ecedd890777ea28808eb06962de83adefc112cf2f8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477629/?format=api",
            "id": 477629,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f61f760f-7e8c-49b4-be21-3b9ed81153b2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142443Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c20ade756c8c8610592e135236b734a59fdac56f35433b09776d74a85717c3bd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477630/?format=api",
            "id": 477630,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3275a450-bcf0-41ff-ab17-728a1885dae9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142443Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8d809919b7cd69e088a6abb3fbf21a8ec7c6fe3d81e6e8276cd364e63f72811f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477631/?format=api",
            "id": 477631,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/95f9e7ad-6a36-452b-82b1-13253b3fd420/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142443Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f05c5bc7058110aaca43128a3896bb0bf69d7fde102236cfc72dccd7d96d340b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477632/?format=api",
            "id": 477632,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/42882cc7-faa8-4b76-8bee-7aa48f0dab7f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142443Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7175edba626529de7f837e94c9a6da3df789dfaba4dae029b822e17bd835bb2c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477633/?format=api",
            "id": 477633,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bba7c891-10ae-4f72-9227-b385cc790608/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142443Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3c7470b74a177cabe65435aeeb892e110618238dc9d05e603f55cb9a87a987d0"
        }
    ]
}