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/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/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/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263179/?format=api",
            "id": 263179,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263179/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263180/?format=api",
            "id": 263180,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263180/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263181/?format=api",
            "id": 263181,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263181/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263182/?format=api",
            "id": 263182,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263182/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263183/?format=api",
            "id": 263183,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c0ba3a2d-ff34-40e6-94c2-447a6f5c0e8c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125924Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9214b80ee8aa643a21252706aafeee399b8b5d84ecbd2eb386bd8838a7288232"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263184/?format=api",
            "id": 263184,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b51841a2-5222-47d8-8822-64ff38149804/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125924Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=649f3a9c11262b247334423652750543a33cc53e58d1bfa231a45144a07abe34"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263185/?format=api",
            "id": 263185,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/367597f1-c8d3-446f-8567-0a81f4ab49ed/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125924Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8a8efcb999898ac759bc00ead9780b06098c58cf7f522f18566504a47913f166"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263186/?format=api",
            "id": 263186,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": "Rate of rise of the water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8ebabce8-1e0f-4b3b-81f1-50d0bf632ecb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125924Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=db52b5554578c8e36bdfb49afd59b144045f21b06070be0290d3584748fab33c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263187/?format=api",
            "id": 263187,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4c57e4a3-6a48-4699-8fcb-2bf71c7e0700/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125924Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fe9e2d68feacdc1222eabb8def4c63f87fe760272493d2c92c7792a11263334c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263188/?format=api",
            "id": 263188,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1de9811f-0e64-430c-8fa2-a9bd216cba4b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125924Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1dbc3559326a58c2843ce7b7208430bdc07f534c12f53c085fad78607dc101a2"
        }
    ]
}