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/821e4a54-b30d-43b3-bca2-7b68807e9ebb/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/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449675/?format=api",
            "id": 449675,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449675/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449676/?format=api",
            "id": 449676,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449676/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449677/?format=api",
            "id": 449677,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449677/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449747/?format=api",
            "id": 449747,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9d27bdab-bccc-443e-9cba-69a2e40025a5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/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=08ac5e2e17662383265c2f1ade7d8156c71e3efc395ab97e691a60971ea58367"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449748/?format=api",
            "id": 449748,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2418ddb0-c5bb-4cbe-9661-dc2117be995e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/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=4cb3f5b5909c4bfddf07a6335f20e692b8f0595907b1944d44ea3cab3eca3689"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449749/?format=api",
            "id": 449749,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/299b02b0-8918-4ab3-9fb0-e312ac7933d3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/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=0305ffb85144342ea9edda8cadacf533edaf44ad83ddf0c7aef0348f2fd3ab0d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449750/?format=api",
            "id": 449750,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5bfa6323-20d7-49a1-9f37-dff318756d7f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/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=67ba27a68e31cded35d34939512b488b7d7574a33ffda40bacc62ba739bde71c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449751/?format=api",
            "id": 449751,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/70b894b8-7492-4d6c-99cd-62b88403c6e3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/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=71baa630c6613db4adeb929d38d32f9654dba83781f4ecdf009eb90d2bc91212"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449752/?format=api",
            "id": 449752,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f5aa2d27-82a3-41c9-87e8-270669748784/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/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=37e854fe5cbd8c6ff7e716ba7cc566162c90dd2a7f622faaefbaff84852838a1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449753/?format=api",
            "id": 449753,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dc039d79-95d8-420d-8d26-c128891b5d44/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/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=8be4e0a83c46f69a05a1743ab1267e3eff650f9a647f55dbbb3564efe742516b"
        }
    ]
}