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/55331a65-c744-4d7c-8fca-4ebc29704523/results/?format=api

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

{
    "count": 16,
    "next": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452262/?format=api",
            "id": 452262,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452262/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452263/?format=api",
            "id": 452263,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452263/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452264/?format=api",
            "id": 452264,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452264/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452279/?format=api",
            "id": 452279,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/224eda40-1638-4b5a-83e8-0667a3be9903/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043657Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f97224fda6ff7cbd7413d004b409d7abd14b7d59ab00289015ffdadf4edefb18"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452280/?format=api",
            "id": 452280,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/213ee878-c29b-41a3-a1cd-a7efab1d6d71/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043657Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e0eb4a855e8e99d4a72ed1bae1e27a2902cfa5b613c6a6a0476d8cfc1ea7eeac"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452281/?format=api",
            "id": 452281,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/577d07de-80d4-48ec-8777-4125dca51dba/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043658Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d7adc6cb06dfba69bcc2fdeaa03d962260f3868e24fd093ff1d74bc8a770afb7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452282/?format=api",
            "id": 452282,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4e2eb9c1-0bc4-4e4f-9495-6a352e8a68d5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043658Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=40abb5e10c73204cf0ddcf69b24a44fba32bb237f9ad09ce27486f767dc762c4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452283/?format=api",
            "id": 452283,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d18b0625-61c4-4097-a243-aed51834973e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043658Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f89bf17a7463cf296f2a46c10c6e83e2887b0d3f350570e34cef54901b093154"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452284/?format=api",
            "id": 452284,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2344403d-e142-442c-a8ef-fcc813b5eb08/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043658Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=57f3b6917450cc30b7e3a66b69dfea7d7406201b6f2555ad2c96a8fb450a8c50"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452285/?format=api",
            "id": 452285,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cf57cfed-583d-4aa4-9e59-c8ca787c52b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043658Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=efdd3372fda366e382a5a31b0ba0fc4413189cecc373b801090f90c382d40d99"
        }
    ]
}