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/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/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/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263351/?format=api",
            "id": 263351,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263351/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263352/?format=api",
            "id": 263352,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263352/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263353/?format=api",
            "id": 263353,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263353/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263354/?format=api",
            "id": 263354,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263354/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263355/?format=api",
            "id": 263355,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c2a6a4fa-3215-46e8-bb44-954602bddfff/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T131459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c8948cba7cf5149c879b86e75095faaa318b95f71ff7339ef7da1200c73e4ebb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263356/?format=api",
            "id": 263356,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0ba5a989-ffcd-49ec-a8ec-b833906a078b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T131459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=799cd39a11c4ef48d1b3962d674c2e31c35f943222e78a23fc15d41049494dc8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263357/?format=api",
            "id": 263357,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4480e766-46e8-42e7-ac2e-a6b9e568485b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T131459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4098abefde412e0e63e3091d25b33b2dfefc6dff36ce505a3d5fe75dc9d6111e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263358/?format=api",
            "id": 263358,
            "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/7ff30ac0-5848-4940-864f-38724ec36612/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T131459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6a0a25d29725dde8903b26a2e8fa87f703d696ac22b23feec3c20c41b4ed9026"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263359/?format=api",
            "id": 263359,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f9b00cce-a9d6-4c5e-8c92-e51b05c81c61/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T131459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fb6f874c1906ad6ec195cfe0b8bc3f5a17ec305021cc6a17803dbcaaa9435464"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263360/?format=api",
            "id": 263360,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b2702b84-7d77-48bf-8e4a-d76222fc90c1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T131459Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c24b316a478ad49c2b65d2fdb6ccb534e6d1b874cfbb41d9fb1b6fe49bcb9f22"
        }
    ]
}