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/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/?format=api

HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 13,
    "next": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425979/?format=api",
            "id": 425979,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/425979/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425980/?format=api",
            "id": 425980,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/425980/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425981/?format=api",
            "id": 425981,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/425981/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425982/?format=api",
            "id": 425982,
            "name": "Aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/425982/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425983/?format=api",
            "id": 425983,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/59700d66-6da5-4e16-956f-8a2ba3e9bf38/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T233656Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d9c24254fbfe8b319dda6713ef80b80f0afe0fcd4398e5f958dc7e217bd9d4b3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425984/?format=api",
            "id": 425984,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/19e5faf1-151b-49bc-8d2c-635e9479e562/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T233656Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ebc0bfc025520403113bb06c8aef4c389e34af27bf798d0293d93e0366c59fa8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425985/?format=api",
            "id": 425985,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6c75e804-4e1d-4129-b578-cb5ce9e4343a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T233656Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a4415922ea8eff9887772cd1e6046f097cb0d38b63d94157bc0b0bcdbf324326"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425986/?format=api",
            "id": 425986,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/05360053-b74d-4b50-aba6-dea688b56eab/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T233656Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=770f0418b444b129ff5c7fb9b727c80c2c92ede219f89f3de4d6e752c7e4564e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425987/?format=api",
            "id": 425987,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b9ab06b2-c59e-4568-9c8a-052693db772d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T233656Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=300867374f143e03acb08a7389d8ee5b1a9f078692210316f3b9459b06ed542b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425988/?format=api",
            "id": 425988,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0124998-b5fd-4e74-9f43-95f89021fa75/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T233656Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1de35d4438f3d2ba510d8baf42fe59f9ee20595bc9548278bdbe951a6327ae2e"
        }
    ]
}