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/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/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/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453475/?format=api",
            "id": 453475,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453475/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453476/?format=api",
            "id": 453476,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453476/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453477/?format=api",
            "id": 453477,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453477/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453478/?format=api",
            "id": 453478,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4cd036e4-c30c-4dcd-ba93-d568533f8d97/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3d3dfd42f4a6971d3bba44dfda8caa8826be4dabef2921bf36d54e0fa6511e7f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453479/?format=api",
            "id": 453479,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/40a3f3fe-9cfa-479f-9cf5-21208c4819cd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2b53d4aebb7fc32c2f42d025dce8388128981bc57e48d2519f1a3188de362776"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453480/?format=api",
            "id": 453480,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d6eb1b20-52a4-4c4c-beb5-e62ff2d02cb1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b281f58d5fedf7de901d084a500c83e60bab9e9c36cb0d6bd8fb9e11b4664b50"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453481/?format=api",
            "id": 453481,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/33785baf-8943-4bfd-9094-5c26135a6480/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1c4ed1d4d61b063b2d9b1ab5fd8a4ede16f30a855be33c6beb6007f18c630075"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453482/?format=api",
            "id": 453482,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/93e54a3b-50b1-43fd-b1c5-bd524d3ead2f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bc80877f376e3c6757f5f560e0d339dcd158ae7787de236f492f0afccd327195"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453483/?format=api",
            "id": 453483,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0a2447f5-027b-4599-b126-13daf57b2f64/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=71d42af174449dae25e1ccc0b0e260ea4c7c65db95f5bc10c241bb5f5e8bed87"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453484/?format=api",
            "id": 453484,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/725445ad-fcc1-4707-8150-98e4ae9b120e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e94954ad81f785542e9278c79c278ea5791a2631af8b3727b3f3b34ed333740c"
        }
    ]
}