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/778276a5-b7ee-48a3-b0b2-9c3517a5c562/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/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441229/?format=api",
            "id": 441229,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441229/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441230/?format=api",
            "id": 441230,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441230/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441231/?format=api",
            "id": 441231,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441231/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441232/?format=api",
            "id": 441232,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b399ef01-b71a-4e64-95e5-f83e20cf038e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191129Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eeb11995300e3631c14aecf84921e1d42be3e2649136f4bd5892397c0c511535"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441233/?format=api",
            "id": 441233,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/93b871ca-c37b-4997-8c8b-7861275d22fa/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191129Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=995f3f84f4ea34518dc25890e42cc8c77bdfcf42d819a78a8b0d827a72dd1ad9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441234/?format=api",
            "id": 441234,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/afde341f-8a5f-4059-b8b2-37d6bc771a62/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191129Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3d91e5f5436ad290f92f5c94242a0c89c848cab586204a97751c4973845c84ba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441235/?format=api",
            "id": 441235,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d315e7d0-6590-4cdb-a1e1-f2ba10dc17df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191129Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eea075ec24f019eb97cd16d978b3e7811e34f677d0bc44f4292d844da7fc7320"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441236/?format=api",
            "id": 441236,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/32bcf152-3b53-4504-94e7-317e0340f0d8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191129Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=179d884deb8130090e095d26d3662077d6dd548e8a499ff5c084b363ecf44478"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441237/?format=api",
            "id": 441237,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/268a828c-5c8b-4467-b4a5-a7258f79e368/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191129Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8c826aee689a680799040fd37f9a022c9c3cb3d3825bbd867dfaf1584f1b4fe3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441238/?format=api",
            "id": 441238,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2a5fa996-6ac4-4ba1-9a6f-c5dd742649be/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191129Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f0c3f3b60e22a23db4926a81b53cf79584626df63be4ebed340a8d7b3498290a"
        }
    ]
}