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/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/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/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448179/?format=api",
            "id": 448179,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fdab7b75-a877-4ed4-9b78-0c032afd0212/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fd4cd5b8ddfd62a575676d38ba36da316df15bbee8512ffd288b8971360edc8c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448180/?format=api",
            "id": 448180,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ebc2291c-2290-4c10-9de6-8f42c571e6d1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=168ca736e496a955014b94aaee9e9479ca0d43319de727ff8a6a9065786d0c3d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448181/?format=api",
            "id": 448181,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/abad6ac6-6084-4078-8320-21f3b4a8b7f0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f5749c457e7fcaba7f0997968c2dde77391f44ed67fccb0d0e8b6e584dd22b73"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448182/?format=api",
            "id": 448182,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/00b912f5-1d20-456b-87fd-e4c683a37e9c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f02d55d60f7f8503e9f6873256591499c4e93557f75963cc17d4a14d95d4b1a2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448183/?format=api",
            "id": 448183,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8a7ce878-c596-44ac-9d41-818042c96077/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2a4ba515a6fa206b02dfbd24dc01740f1254d0194d91dbd9355d61209c57a7de"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448184/?format=api",
            "id": 448184,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2277c198-501a-424d-9247-7a92f4bf2a40/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cac44a74bdd314c3718002bdfc910daf077ef817f33eae0d61c48daf3387057b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448185/?format=api",
            "id": 448185,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/46d870e0-d7c7-4273-87d8-8d303f9d27e7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aa2480400dad38f97b67376fd8db5a062ffd88f9bf203463f8ae985d4787663e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448186/?format=api",
            "id": 448186,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a805edf8-1e6b-48cb-862f-1a7a6ea545cb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=127b8e28b4109b23a2317af4eacce99ebbe0b3f304a41160633b66f459362f8e"
        }
    ]
}