Result List – 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/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/?format=api

HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 17,
    "next": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454709/?format=api",
            "id": 454709,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454709/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454710/?format=api",
            "id": 454710,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454710/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454711/?format=api",
            "id": 454711,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454711/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454712/?format=api",
            "id": 454712,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/42c120b9-c432-4747-bafa-fcc2f2cee250/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7fdd67be92ccadfef302a976ebf75f6ef0765d876478db6eb71acc2cd96e1d30"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454713/?format=api",
            "id": 454713,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1c3cf016-e141-4ac1-a348-bbf6de584e73/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=62e1bedd67db6a9351f95f8c398b1c2c70bf588960def16365ea5f6719439cdd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454714/?format=api",
            "id": 454714,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f62fec87-94d7-4f4a-96c1-53287e7f083b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fb083e609ea347d23e8faa28104defb014aef0ef4512d3b89a3b3c68ccf62d0d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454715/?format=api",
            "id": 454715,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4470f2f-b351-48a4-bec0-19d6e20a2938/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aa4f1f67da9d5941568f0b2f40bb6ac44e78d8f63f21717d0d72016c40929530"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454716/?format=api",
            "id": 454716,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f0fd3254-37d2-481c-883e-e680c0945793/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7f198320cc43ed2108fe84c5832000d5aec2e41ddfb4186a5a4aba57b037972c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454717/?format=api",
            "id": 454717,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/309a4600-0a5b-42d3-b103-9b155792a59d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=564471572872a183ca7eadd0832ff7a71ec435245723b18e8ce7a926e2f96379"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454718/?format=api",
            "id": 454718,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e54db3bc-af65-490c-93e2-9aaa6374c5cc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=df27fcadc5acda0dd9383accd2b51ddb1059a1dae159b22aa5ad0c5698c42c16"
        }
    ]
}