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/5cf352bb-a6ae-4425-b276-a20fbfff45f7/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/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436528/?format=api",
            "id": 436528,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/436528/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436529/?format=api",
            "id": 436529,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/436529/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436530/?format=api",
            "id": 436530,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/436530/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436531/?format=api",
            "id": 436531,
            "name": "Aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/436531/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436532/?format=api",
            "id": 436532,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4c75e2b2-1a87-438d-a217-f9373f9d5399/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044352Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c03dcca6a790d1f0d49b36cb6243ee9b7c5e14deafc62c4409b1be0a15d8f23e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436533/?format=api",
            "id": 436533,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4072c9e-c55c-4489-9920-43903d2f4afd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044352Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6e0f975c9207ab91046efcb05bc4b7e6f6971e225632de230971f6fc36936799"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436534/?format=api",
            "id": 436534,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/84fbc2b7-366d-4348-91fb-2f0306ea4319/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044352Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=daf7c7e721887a8a245068dcc87b4bcbf69e7f2cab49ef4bc7c70b172fed5aa8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436535/?format=api",
            "id": 436535,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4a2033e4-2f0a-4568-8193-2896e357483f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044352Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=17324894e781ff0f85ce51a08fd3719ce86717bb6a667df17529dcd8ca3f7b2b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436536/?format=api",
            "id": 436536,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/42e76233-c82c-495b-b169-cbd816ef6191/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044352Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=be1446571079d461f10d97500dbc88bbbf35c3a60a38f2f92e985237733ef74e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436537/?format=api",
            "id": 436537,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d5c93d06-c1e2-4e05-81c6-12859cfe758c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044352Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4abedb24b25df5d88856d3043968966e4074c83a7f331f81b9933ff080e17ce5"
        }
    ]
}