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/a16cf582-498d-4baf-a9c8-99a87804c9fa/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/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448150/?format=api",
            "id": 448150,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7f0e2201-46ea-426a-a9bf-d53697598093/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012028Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=392e7caa638b664971e89afb38d2e562d2ee657107752b5eb5b3be48ab020570"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448151/?format=api",
            "id": 448151,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d21ce0f2-2f1f-477f-8a03-274961171777/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012028Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=99d3fce82a88b93acdee7558e8842845c54bb01dc448c527225557dff2fa5f4a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448152/?format=api",
            "id": 448152,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/83dec6d4-4356-4867-8419-74e62ed52ba4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012028Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=47621a5e83e13de964c79889406012d54148763686ffa4438bfeb296bd273644"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448153/?format=api",
            "id": 448153,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4a3a79c0-8cfb-4579-a586-2efc985877a5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012028Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f1c06fce2e0c6c54100980e3849e25f5a4ddf0daa23c21d1bf789eba5b028012"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448154/?format=api",
            "id": 448154,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9199dbc9-2c00-4645-b460-e493ac068aa2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012028Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2ef3f0410967f30106c88ac3e2532a026531929af9278fced05e6d87f7023748"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448155/?format=api",
            "id": 448155,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2782eb13-8fd6-41e9-827a-a97629e873b1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012028Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=16270b74ef34c874754ef4da7ce955d5ad312a8b11093824c0650a2bf20c8982"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448156/?format=api",
            "id": 448156,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/963c8300-0b1e-496d-861d-a3a7e9fedc81/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012028Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5b67efde7643250d3c91694accf5dfd907dd68d518551c87b77536384ef42c18"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448157/?format=api",
            "id": 448157,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/44d55c83-33f1-47dc-ba53-edd912d30c4f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012028Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=770480166c93b29270db4ae038907636fdc303090d97bed6a684a5153fe7629b"
        }
    ]
}