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/a4058100-14b5-42f2-8836-f281d9dec06f/results/?format=api

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

{
    "count": 17,
    "next": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455413/?format=api",
            "id": 455413,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455413/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455414/?format=api",
            "id": 455414,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455414/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455415/?format=api",
            "id": 455415,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455415/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455416/?format=api",
            "id": 455416,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b69c8092-94b1-4ae7-a7ed-25804a1c2812/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001611Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=273ffd45df6d8d6efe1726ce964a1ae12b7a321f784555b6774a27b447441b69"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455417/?format=api",
            "id": 455417,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2d1f7bc4-3d9a-42d6-ba1c-955b00149802/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001611Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1a39f0dcbe3764adc365c126b780944fbbdcfc828f6915925678f0faa2c8f398"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455418/?format=api",
            "id": 455418,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/322be1db-b2d1-4116-aacc-556ae73cce74/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001611Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=decc30a5ed73529405100f6517d38513536d6060ff062afdfc8feaf78d5c40eb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455419/?format=api",
            "id": 455419,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/81188f0b-60fa-4481-970d-300397b30243/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001611Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c4dee505ee456dd5082dac977eab946cc12d461e997f5ead206d0b76fa0df931"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455420/?format=api",
            "id": 455420,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/396b06e7-ed9f-450c-bece-dd9d1b8601eb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001611Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b73df995cead6925d0f23b638a763f09d41246941cd412d7e0807597a7e9d828"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455421/?format=api",
            "id": 455421,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7cea27af-3812-4705-a447-8a6e904c08bb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001611Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=875833be9c95136d3c5cf18e30c3d2c280c14352b41f4cf933dc0ee2817383ba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455422/?format=api",
            "id": 455422,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7d459cb5-3dcd-4aa4-b309-5bbc2b5756a8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001611Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2e8df202412b803ba62c46488160e2c70d3ba7de79a4b7f4a4b4fd962c7166fe"
        }
    ]
}