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/68b823da-f5ab-454b-8314-597b02caf6e4/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/68b823da-f5ab-454b-8314-597b02caf6e4/results/449659/?format=api",
            "id": 449659,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/82fc91e9-9ebb-4e01-a410-9965b92e80ee/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a623afbeddcfde38af7640dbcbc32977ce0c8f80baf0ac4f03ac884361109eac"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449660/?format=api",
            "id": 449660,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b6c3a76b-76cc-41b5-90b6-daa1701a285a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d5d4371d086b2c1fb8e9d878788e7a2442a24a98209cf7882405233262eee13b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449661/?format=api",
            "id": 449661,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ef26274e-7c6a-4ef4-9888-c14d42a7a52f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8708d096a6edfbd7b13770d63f251ce5addb080160e075aad8024cc8130d8af7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449662/?format=api",
            "id": 449662,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/76f9c61c-960d-41a7-805f-1f808b4c4486/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ec283dcf8428810a80e74fb469e82923f93648b11d03b908934f0cde551094be"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449663/?format=api",
            "id": 449663,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5b82b901-f136-4ed3-b42e-b67582e475c3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f780192b19c02bd045af548c734ec779aa88f61366d809149803b293630e4d0b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449664/?format=api",
            "id": 449664,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1c4ce56f-9a9a-45c6-bc51-5ce1157b0515/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b6d5a349945fe67c2a660c7843305ca55eb6455e055136896671b47dcafecc06"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449665/?format=api",
            "id": 449665,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/075c57c0-068c-4102-9ec5-c86601e01206/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=10551742d3fa9e989fee58d9c93989c69ab06e4cc881cc90bdfa541e685c70f7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449666/?format=api",
            "id": 449666,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/17d63bed-3e9b-4887-bfe0-d8ed53018109/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=56e57a9be61d375f3e196df8746adb01c20bd3497c567213de9fd66850ead1da"
        }
    ]
}