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/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/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/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452379/?format=api",
            "id": 452379,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452379/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452380/?format=api",
            "id": 452380,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452380/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452381/?format=api",
            "id": 452381,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452381/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452382/?format=api",
            "id": 452382,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fa40ed23-b166-4ca5-bd5f-3037f42957e9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032514Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b7ab916804547e952d5d572c822088956416e95c50f2ba070dc755d156fd6823"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452383/?format=api",
            "id": 452383,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7dda30a5-2faa-4e18-9753-f42f754a916b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032514Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bbd689896b90c45466812d99aa369b466fa0de987d52c707cd0fe0f2e80fd74f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452384/?format=api",
            "id": 452384,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2b0718f2-bed6-4576-a1ac-aa1323c71096/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032514Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=81a7805732c2f6d3c65d8613a9ccf129fc075d037d4ce9d65bbbaaf25c46d537"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452385/?format=api",
            "id": 452385,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8d330445-901c-4c1a-afbe-638ae04b418d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032514Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b06a2799050047189e8d17631a672445830e81618436e89eb68cfd7afe042a4d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452386/?format=api",
            "id": 452386,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9144be7a-550e-45c3-8571-fd3f30aeeb48/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032514Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=794ce79b4c0c1ad27d3d7fc1a1da09d19167757cc89de2cf3ae2e31665b1f802"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452387/?format=api",
            "id": 452387,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/db295b00-7b85-4ac5-be2b-b1fd32166592/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032514Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=55221f3a64b70f7f89c0bdd8963e35c8867e7274724afcf7bc9e78ef7b040113"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452388/?format=api",
            "id": 452388,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/277f7b76-a3b7-453b-8a03-c355870b4585/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032514Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=515812d1a341bfa0be53768f66416f96660899dede6b1a272eeca59bc4fe0f51"
        }
    ]
}