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/761a0c61-422a-48a1-b255-a57f86193a3d/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/761a0c61-422a-48a1-b255-a57f86193a3d/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263167/?format=api",
            "id": 263167,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263167/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263168/?format=api",
            "id": 263168,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263168/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263169/?format=api",
            "id": 263169,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263169/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263170/?format=api",
            "id": 263170,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263170/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263171/?format=api",
            "id": 263171,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/596cbb80-ca1b-446b-8b3b-d4a09bfe656f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155739Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=64a9c98287cba32233ea8daf349a8d137aae65cece6028a60ebc4575a2d6ca7c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263172/?format=api",
            "id": 263172,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f9649010-a911-4859-ada5-1984bc65d407/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155739Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=53e2a7278b020ca20a18fdeefd667c9faa10e7323f8a155f3eebdd1fb87e677e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263173/?format=api",
            "id": 263173,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9e1095b3-6ce6-4f40-bf46-8c15a47d3d44/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155739Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=28fbd9182f6daca9430837dab664be98982124ecf3d1e29605bf966fd01c8fe4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263174/?format=api",
            "id": 263174,
            "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/461af5f1-183c-4b96-9566-0e1a6f22a1e3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155739Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=22c35e515f4fa7791e344d40e53435e385c4fb5c6d04a5966dbe8da730727749"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263175/?format=api",
            "id": 263175,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3986e82b-ad50-46d2-bd48-95b28ee018ac/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155739Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=07d1b4c4a0a1767fbad6461f28f0c4290155ddfa1191993f62ba2661f380f497"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263176/?format=api",
            "id": 263176,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d427188e-c20e-4c55-8179-0c0288b2e16e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155739Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3f3733f971bd0a249ec997e8d98a421b418277177224773d4dc0f6b75334834c"
        }
    ]
}