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/e36134fc-e96c-4a0b-86c8-d7e028e06db8/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/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452188/?format=api",
            "id": 452188,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452188/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452189/?format=api",
            "id": 452189,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452189/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452190/?format=api",
            "id": 452190,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452190/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452191/?format=api",
            "id": 452191,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6f11705b-4695-4a24-9fe7-a38483aa779c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T022133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=64e2805aa5777ad73c39d6c9e33b1c03908d5ffbe28430a8df0d01ca9dd88583"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452192/?format=api",
            "id": 452192,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2da69008-0a3b-40b9-aa2c-e02fbb21d970/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T022133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=93077bbe8cefab74165845962a5ee027eab7a8f793994ff3a6d8627c91fef886"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452193/?format=api",
            "id": 452193,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9f6ecf32-9a5f-4254-b42a-35c20965552e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T022133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cc066129c5588b0b5ff84e7dc1e331a49a4bf20518afe78ddfaea2bcde73a3ad"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452194/?format=api",
            "id": 452194,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8690fde9-0da4-4e75-af7e-aa270fa3f9a0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T022133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5553c471e371cb771af75cc64cfa7d955ab73b3ad36ecb864250e6e127591e36"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452195/?format=api",
            "id": 452195,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e5ce011f-f663-4fd6-9969-f991179ba694/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T022133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=90885e1c5ec7330ef89938bcd5f8b2924bda9a23eb0ff2f20461b2a1a7eb665e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452196/?format=api",
            "id": 452196,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e3878393-5592-416e-a042-c1e59c96c256/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T022133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=977293dab4730ebf0e7638c9ca8e623399dc2635ba8132f3502965c1bdca5d00"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452197/?format=api",
            "id": 452197,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3277000e-3b1a-474e-ad89-188c9d788bc1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T022133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=69a02726621cb90c00a557d617f5dbf8c5279684901503c013e8c6dfb8e51f7a"
        }
    ]
}