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/1d895334-6aca-4445-9fc4-00d500ff4a03/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/1d895334-6aca-4445-9fc4-00d500ff4a03/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477622/?format=api",
            "id": 477622,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/gridadmin.h5?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5604fb6117c51f0061a46b2a9d784f25171ec72bba3f5ba86e6dcb4ee73c0aa8",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477623/?format=api",
            "id": 477623,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results_3di.nc?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fe7792383f43bc88ac637b4c578c0b27d6697e2409a56f55371ae176f6f8dbef",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477624/?format=api",
            "id": 477624,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/log_files.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5a9996595a209edf6909b78aef31e04d1776d11e4cc8f4c1a167012288792781",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477625/?format=api",
            "id": 477625,
            "name": "Aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/aggregate_results_3di.nc?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bbc581bde51a02ac142c2335b50a45f8f30c0daf8f2c6b8b067182fde729d0e0",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477626/?format=api",
            "id": 477626,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/84c9d592-be4e-4f53-b9a5-b78bb96439db/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2d26ac2e9f3765064bdc5c455cecc7ff47020048ddcf1e267ab62c444081b767"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477627/?format=api",
            "id": 477627,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3a50e1fa-ef1c-455e-99d9-a9955e181897/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fdf50ad83e1053bf9de2554a675e8c9bd9a18d4225e1766c54701e4cac7adaf3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477628/?format=api",
            "id": 477628,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c61f570c-2e04-4457-9423-10b8e5171db4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=503fd851a947bdfb5f3a72d0de1d60927f1b5a9eebc1e845f4700d6bb070d124"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477629/?format=api",
            "id": 477629,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f61f760f-7e8c-49b4-be21-3b9ed81153b2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2692ad0c3d1e2a604b8327602636b11eeb0164d9543b0b15d1ec2d7b300b57c0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477630/?format=api",
            "id": 477630,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3275a450-bcf0-41ff-ab17-728a1885dae9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a47d45a5c7cc7080eb98968d7cf3fa169fc19a13f214de2dc81df3c8ebf028e6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/results/477631/?format=api",
            "id": 477631,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/95f9e7ad-6a36-452b-82b1-13253b3fd420/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d895334-6aca-4445-9fc4-00d500ff4a03/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ac8e36197290679678b3a3c2501ffbb658f01e56cf40fcd666b6a9c4aa238ffc"
        }
    ]
}