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/aee370db-d66d-4864-bcf2-b83149c71f8a/results/?format=api

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

{
    "count": 12,
    "next": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490229/?format=api",
            "id": 490229,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/gridadmin.h5?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cabd501b90741b0650e0f3bc2435aa813fc937825acd5ad6ecef29e1abf00fe7",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490230/?format=api",
            "id": 490230,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results_3di.nc?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b62b353faf7d7c0376399356d54a30443c0120f62b882d5682aae6d155213945",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490231/?format=api",
            "id": 490231,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/log_files.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8c9186f2d8284a025338fb057d583b3e55ecbf5bcd328808666a56f21983cde8",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490232/?format=api",
            "id": 490232,
            "name": "Aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/aggregate_results_3di.nc?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9a638169ec2ca1a9da6c11e7fb3b2794c78c49476597968c80d588b6df7a14db",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490233/?format=api",
            "id": 490233,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4e860e4e-1aec-4d1b-989c-af730e438ba6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f23d162f316880b927afe63b0a31087f50ac18bd30898d8a451ab5089cb86067"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490234/?format=api",
            "id": 490234,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/79585579-bb69-4969-b89c-8c65c7d533a3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dd3e984dbc8363ddade2b9678892f75ee224fb1f34cb3eba3fc43081a03ca783"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490235/?format=api",
            "id": 490235,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9cf0dfc0-c8ee-4726-89cf-aeb35283ea3a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8e0aec714149a8241c1d55776538a97d8b6ea7b399ad6e92e3eb0072f06b2576"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490236/?format=api",
            "id": 490236,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/137d785a-93bf-48c4-9db0-7ccec2bf4869/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=08d8d7fdca27e981140ebfba65787769b8066ec0c9d6ef263adb9613278cc5c7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490237/?format=api",
            "id": 490237,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee8e3d32-1859-4de4-bb01-449d75e1ba2e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bb0953860ed24fb4c18dde701cf78842981005b615c5a269dd6e854a5dbd20c8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490238/?format=api",
            "id": 490238,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cc33480f-5ce5-427f-89ef-543bd210590a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ac273f33c9d00396aa13aa801e12c9dbe90bd811d49b350410e63c1ac6cb0cb5"
        }
    ]
}