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/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/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/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/results/469722/?format=api",
            "id": 469722,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e1fefddd-7153-4b51-937e-b17430e25acc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T132654Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aaabde26e24c70f49e66b78965545a0691aab82354ac36ffeaac83827e684407"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/results/469723/?format=api",
            "id": 469723,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/244b8119-ec45-475c-868b-72dc09674fef/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T132654Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b972c0d12f931c4ed740e1349c8ff61f2b666e12901d9587b1f0ee7052772c71"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/results/469724/?format=api",
            "id": 469724,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2dd17110-d0db-457c-84cb-bfa844da1ebc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T132654Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=91cfce6344be380da66f2dc4253b410e2b4f0296590e044de40b10e3972192e2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/results/469725/?format=api",
            "id": 469725,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/592546cd-bf09-4078-85f5-36b56e6036e4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T132654Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0755beec3a6000d834b5f12b683f7a098553c544a38777bea2b67d9e1038125d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/results/469726/?format=api",
            "id": 469726,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5ec4176f-7da8-47ff-9d5e-cf882f71d697/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T132654Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=06d0e94f06950384d1a5c80c6862ef2f0e0ab323c3c1340e68976c2cbcfc9be1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/results/469727/?format=api",
            "id": 469727,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dd4ae0e8-7ed7-40cc-ac8e-9cb9bd79f54f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T132654Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=acbda796ed7bc57f763a9b9daac7411b32595565dad6783a490b37f016654e25"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/results/469728/?format=api",
            "id": 469728,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6edf1044-9662-471d-91b6-7169921ca656/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T132654Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=86fdad8f9c31d93917a1e942c7146308881cf7e0a977215569feb0e18d40e189"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/results/469729/?format=api",
            "id": 469729,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a67da28d-b5e9-403e-b49d-8717192919c7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T132654Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cc6a676d259d26d396bef432a995b3cb065cb2d2f1e68d83fde2f8bf6d8c315f"
        }
    ]
}