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/19e8535f-2945-4ce9-9fd0-203b74de3889/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/19e8535f-2945-4ce9-9fd0-203b74de3889/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453738/?format=api",
            "id": 453738,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453738/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453739/?format=api",
            "id": 453739,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453739/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453740/?format=api",
            "id": 453740,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453740/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453741/?format=api",
            "id": 453741,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a8246890-7be0-4626-84c5-faed81e66900/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/depth-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=c9aca4fae963e29434c4ee8dcf01d3b65f855ef816b8b9f6fa4a21f4fbd38534"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453742/?format=api",
            "id": 453742,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/80adb603-49bb-4894-b680-c6868aea33e3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/depth-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=4bdf89377715fd191cd906cbee3b0b2195cf778cd35053feff4fae06a6d5e7bb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453743/?format=api",
            "id": 453743,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/523ff1f9-c952-44c1-b694-13890eb229ac/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/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=5256504eea53f323b1946ae1d15544cc60867267e8481cdef4230ad3eca39ab2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453744/?format=api",
            "id": 453744,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d9102db4-158c-4ecb-830a-83f65e46a860/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/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=8398e85d4232374a41a918f3d28bce689c018ad9fccf76b372733e681397f54f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453745/?format=api",
            "id": 453745,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ecebcda8-7611-4946-87a4-91a932b4f281/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/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=c7231068345e1479e5ba0fb98504368a655abbb55e87897c0a67213913ac98cf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453746/?format=api",
            "id": 453746,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0e221da3-c729-4aa2-b34d-1f2b2630a215/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/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=7aaf937d02189c3d93f8c4b47a316d128505833cc47a372c04714f92fe7b448a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453747/?format=api",
            "id": 453747,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7f8391c9-35f0-4852-83b7-97b633ea0781/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/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=bee66acdf64047dab863e0ffb678839c55a18dfcab914335f6b60e783f194673"
        }
    ]
}