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/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/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/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449265/?format=api",
            "id": 449265,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2825f024-9ec2-4070-9202-026c77135ccf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154406Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fad2f8541b387c196f93d2802833cb4c4960bccdb0397c958d7abf260de56a5e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449266/?format=api",
            "id": 449266,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/95c89a9d-94e1-4911-83b7-8185e10454aa/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154406Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e42659bcf8fa9cfd4e02f70abbad72d496bed43177643f1abda7a3b77ff92692"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449267/?format=api",
            "id": 449267,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee1b9d50-4458-4c71-8fe9-050c6805a9af/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154406Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=29ddc99c9d7d210cc6c359aa32cfc6e92b29d3880025227c416cf4f54c353f67"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449268/?format=api",
            "id": 449268,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e9715b32-def4-42ff-80a3-19c604e547b5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154406Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=936a34ae1434d8ba6296bfe955950fb72cbff87e345ecc87676eb785755f7149"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449269/?format=api",
            "id": 449269,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/71955252-8a08-4509-9ff8-6e5ad4ecaf05/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154406Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=79545e02d46cf4fd3f0b1062fd76a58a4d1bc3884d9cf0e5d656746a4c7ef2eb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449270/?format=api",
            "id": 449270,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/036a271f-287c-4cd9-ae1a-8fbd188bdef5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154406Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0bd92242a484357934b542c2670a4ce4c67826673c52858fc4dc3531f2981c3b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449271/?format=api",
            "id": 449271,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/916b14b9-6958-4ad1-80fa-439999c53ba9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154406Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=169e88e746386e225d526398552ff4032688c9b8638c33fcb02d6406c7a99f0f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449272/?format=api",
            "id": 449272,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2602685a-0622-423d-922b-a3bb600d88e7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154406Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b9c473466a8c7df41a5e74e30d0916250bf5b6eac430fa5aba947cf57576b234"
        }
    ]
}