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/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/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/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452224/?format=api",
            "id": 452224,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452224/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452225/?format=api",
            "id": 452225,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452225/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452226/?format=api",
            "id": 452226,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452226/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452227/?format=api",
            "id": 452227,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f7d0629f-b013-4986-8224-ba46a623010e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a73386ee5c02c23f69cb00ca8d361a25c2a3896af7c76ddb31d9202080c85f98"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452228/?format=api",
            "id": 452228,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/63acce25-90e5-418b-b070-99ee944cbdb1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=da0f5c79becdb7fc4de2397476eacb1276c6413e4e4ebd5f1aa7ec1fa4dc86f6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452229/?format=api",
            "id": 452229,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0ddb10ea-0f0e-4351-8909-d74decf33993/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d474da5f1e6dfc0eeff548a786d7c93dbe7bcf84731ffa18757995e90d266e56"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452230/?format=api",
            "id": 452230,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/27c86190-3447-439d-a76f-cffd53a7181e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5015ab9f8eca5ed79fd62829b3f0ea21afa0fcd2b2c00b189a2da85f76b06eac"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452231/?format=api",
            "id": 452231,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/268f00e7-187f-49db-b76f-d5d3fe61334b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=27b6af41d8fb43d7e4aa0d53842bf988f0423446b8f36265ba9116cc1b53cdd9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452232/?format=api",
            "id": 452232,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/047e0814-53ac-4029-a499-d98aff0385f9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fe84cb7329909d1b16597e0d767f56324c07d8329badf3e64345ab0e84dfdec7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452233/?format=api",
            "id": 452233,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/026373d4-034c-44bc-81e7-53f4689ba478/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c46a006bb50644d457006ba6251214463a732a7062b08b70baa3e24a91fbb80b"
        }
    ]
}