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/f03f4057-8dd5-4b89-b144-bb80b0489532/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/f03f4057-8dd5-4b89-b144-bb80b0489532/results/449581/?format=api",
            "id": 449581,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/209f5888-b398-4838-b5d1-33b2f3a1419b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fdc1f3b532b3066aaed8e01514cac7eac8cd073ee44fc1712a77ea60143eeda4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/results/449582/?format=api",
            "id": 449582,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1544b537-8f94-4a5d-a226-a01081fd5862/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0c5eb1cb0f110da3ac512d551f28794e20d4b29f95eb676183e95850e4b7fb05"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/results/449583/?format=api",
            "id": 449583,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e412a59a-4838-46f1-8f98-5d7f2050c3a4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=200cedf40b1162c5a6300804cbaff9951408b024f47388ebc16e84b3c729999f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/results/449584/?format=api",
            "id": 449584,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/12278f65-b60b-44dd-976e-2a128813fd90/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c53b993602e4bb10819fdfb9dc37e772bb48342ba40f44bef5ece898c17c3cce"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/results/449585/?format=api",
            "id": 449585,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/30a20ddc-e3cc-4642-b00a-dbe2e6efbcc6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9cbd8c98a8ce0340995b9c32e1ba936ee4ea4dfb78f246c2eecde0388ab4c6ff"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/results/449586/?format=api",
            "id": 449586,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/995d5d76-b0cf-4f09-b1c3-e6fb3422263c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=412ff8a713c6a0f7e2f8fcf064159ec6c4e0b78823bbe79d881ecf974de5bd86"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/results/449587/?format=api",
            "id": 449587,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ea2f2b35-c2e6-4c95-84b0-371b4936db1d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=34a927b6c4e65a7ebe3c2230a8fc86e146f6e0bb5edb34705897b786575cd467"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/results/449588/?format=api",
            "id": 449588,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8d14ee5b-392a-4120-8c14-dc1d695eb9dd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f03f4057-8dd5-4b89-b144-bb80b0489532/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f0ba7007b3f6327100b3082bafb1db8b4d7496004a264da1a3df84f351525dc0"
        }
    ]
}