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/778276a5-b7ee-48a3-b0b2-9c3517a5c562/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/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441232/?format=api",
            "id": 441232,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b399ef01-b71a-4e64-95e5-f83e20cf038e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011044Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=31ee5b406f8acc5317371e7b07cd4e12ced7f5be1174dfae0dc95c0a63df4474"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441233/?format=api",
            "id": 441233,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/93b871ca-c37b-4997-8c8b-7861275d22fa/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011044Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ef3242fb938819f99bb1cd9b3c8efebf13ae1d3c99d481e11b747e73f5cfa2de"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441234/?format=api",
            "id": 441234,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/afde341f-8a5f-4059-b8b2-37d6bc771a62/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011044Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=496b544fa0882d0010d9e1b0b50c643095ef63ef8b194b1778ce71390ae597c2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441235/?format=api",
            "id": 441235,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d315e7d0-6590-4cdb-a1e1-f2ba10dc17df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011044Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c49c481212014147efef9ea4afdbe6d00e88709372db9c19f4250abe39c32a1f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441236/?format=api",
            "id": 441236,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/32bcf152-3b53-4504-94e7-317e0340f0d8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011044Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e5c5c2b6b17b39b38e0a65ebbea631b6f32489448361ad193b4a7f9dc885de19"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441237/?format=api",
            "id": 441237,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/268a828c-5c8b-4467-b4a5-a7258f79e368/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011044Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6c09a90c393c5d6c13a1e12a02959221d335839fd80528ac4166fe7c0574fd24"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441238/?format=api",
            "id": 441238,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2a5fa996-6ac4-4ba1-9a6f-c5dd742649be/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011044Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fe1178600ed5c905cd6543d8a45321e018fe7420467ffa46d9dc0c4ef2acdfe8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441239/?format=api",
            "id": 441239,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ffc99601-451d-4d53-8141-a57d5d4eb1e7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011044Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=70c127cad174c30fb9dcc155b3b610148bdbf266d2ad29e0b8ebbf73bb3cee71"
        }
    ]
}