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/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/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/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436520/?format=api",
            "id": 436520,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/01bb28e6-8fad-4159-9d16-a89c3a472b15/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ee183cef4ab6af4c54aa2dc839545e7f4bea88cefe8f9d9a28577f5e54670222"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436521/?format=api",
            "id": 436521,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/87fd8dd3-bf4e-4e26-a506-37f10262af1d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4fb4185b32df73a44207dac3c39270b40fc37a71881c587a796bcf0c0e5b4f3c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436522/?format=api",
            "id": 436522,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3e988175-b1c8-457a-9459-0ba24bf7850f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4b1cbf7dfbae22268f02ab558042d88b323a0c3753a33f69e739b0018f91a654"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436523/?format=api",
            "id": 436523,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9a8277e6-9175-402e-85e9-8468c6e81650/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f916ef3e21027e74bafdf4d9c3eb33e2395975dd03e7971167bf75a6e3e2aa70"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436524/?format=api",
            "id": 436524,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8eb76024-243e-4c1f-ba36-3a8174ed55b4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=37cd58fac190b328baacfd587aa1d34dcca2960d310fa232791ed9ba7806931b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436525/?format=api",
            "id": 436525,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0e08b75e-0ff0-4e7e-9c72-27d619f3b772/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e4fa7dc3923a3d480753cee36e43875afb59073843b340fa90ddeadc8b078142"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436526/?format=api",
            "id": 436526,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/34450f70-c6e6-45a6-84da-7b877e4f9011/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e341c930339fbf27cb7eff29d500a4ef6d188d6815d3fd7f08ac289fe0d46e05"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436527/?format=api",
            "id": 436527,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8ff571a1-449d-4438-a085-d10589a29257/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=43483cf88c80132fc2efe20798cb7c0687f77ef3a936c4467a54a4e75de1dce1"
        }
    ]
}