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/90ee6870-18da-47ec-aa04-fbc6e5f7e038/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/90ee6870-18da-47ec-aa04-fbc6e5f7e038/results/498728/?format=api",
            "id": 498728,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c6e1d5c7-e7ca-4122-95b8-bb7637d76013/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T125524Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ab580ff9e7ebf11e99238a66ffab7440251b10d11316ca3a41035951181ef76a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/results/498729/?format=api",
            "id": 498729,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/371856d5-f02e-40f5-bc2b-0e62b5129e6d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T125524Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4a83ad364e089f4e5d13a98fccb2241952fef1decf421008f07c1d34c7ed6151"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/results/498730/?format=api",
            "id": 498730,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0dff79c6-e67b-4805-b7b1-99b0f8f6d4f9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T125524Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=48a03e661b911e6947907329ee8c807fd49c6a86b20c28cb80b5e3aa90914d40"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/results/498731/?format=api",
            "id": 498731,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5cb25832-82b9-4290-9eb8-43a47ec53e6f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T125524Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=da2e8719370bd0d1623c0f32b7cd49971149f89830f5751e21a454d4f03cca7f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/results/498732/?format=api",
            "id": 498732,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d4371473-3d73-4464-bc1a-5cc4236f950e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T125524Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a4588158714f948cc6459389a92b38f2144340af1008450b38a6bcdea7168f99"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/results/498733/?format=api",
            "id": 498733,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9087d64c-3def-4ab8-860a-e6bf477a734f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T125524Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=efeaaf8812e0b542663fabee0ab7f2ba0c2ced59d31ce160b1088911d7b3c8e4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/results/498734/?format=api",
            "id": 498734,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/70493c20-f9c0-4a10-8ce2-40ad27a1e1b2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T125524Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=89ea10c4388e432696717e8f7936677e16ff5d9d27906332854a4b87ab8fd9c6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/results/498735/?format=api",
            "id": 498735,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d04b3ed5-f2e6-4056-b558-bf7348ffc85b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/90ee6870-18da-47ec-aa04-fbc6e5f7e038/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T125524Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cf68fd264888c9b17c5e37d696ef385dcfbb09f5c68764df5caa5d2cbb8cdb12"
        }
    ]
}