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/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/?format=api&page=2

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

{
    "count": 16,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452198/?format=api",
            "id": 452198,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b979ee73-f7c7-4841-812c-dffb1d8c6211/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062203Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=267298a1a8f7db56d1ebf804700ad12f1741876f469e54b89fda1456f25ce88f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452211/?format=api",
            "id": 452211,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452211/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452220/?format=api",
            "id": 452220,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3df983b2-4929-4bd7-b801-c8f291c8d8f2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062203Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9d9b76ce9cee5aecb2486e944489ac1f77cd717c04d198ae8f510ad6d44c50ee"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452221/?format=api",
            "id": 452221,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/082cf2fe-80ec-476f-98d9-02081c9f90e0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062203Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=61dee0ba6e0f14c110a1c86ecaddd8181068dd43388087426f6d9e4726f7ef5c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452222/?format=api",
            "id": 452222,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/70f36ad7-0038-4e42-ae54-fc7d50ef5123/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062203Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=10503be7719a9ba0b26724a71f6036b1be7586efdf99d6439780111257737cde"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452223/?format=api",
            "id": 452223,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/4b6f30cd-007d-453d-bf77-16da7ba8444f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062203Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=34cfc2566ca89601e92cfcb16c6afacf41635fd461e071b03b4ce53009366de6"
        }
    ]
}