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/78d58488-6b84-496b-aee0-f302c21cd95b/results/?format=api&page=2

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

{
    "count": 17,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455967/?format=api",
            "id": 455967,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/103e0174-3a11-47cd-aa08-f3efdd585df2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=da15714888b6b5028e8c86087128f463be3e026ed1d7ff996f9858cca0b0a8ec"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455968/?format=api",
            "id": 455968,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/d2e71ee4-6953-459b-b1a7-e3686d4087f6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7cdbe2ff5f0f1b3f50471fe4dcbe87e742745f3f11ae4960c938e6ceb0f691ae"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455969/?format=api",
            "id": 455969,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455969/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455970/?format=api",
            "id": 455970,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/40e1472a-ad72-4b40-affc-5b6d6a575a9e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=087adfcc6900ebcd830edc1eb976a21a85cf019605b19d0a7f46a9790ae0b908"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455971/?format=api",
            "id": 455971,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f9e22acd-4b34-4795-8a04-e8e47290ebda/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7c369bfbe8073a6321601317987bfcee4beb857cc8304130749a262386880c46"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455972/?format=api",
            "id": 455972,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/fd4264d1-0e7b-48da-a4a6-e463d8a1f756/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=07fcd371b153b4f93c8142e020313436d5a568b1261ee145bf253899b4b0bbbb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455973/?format=api",
            "id": 455973,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2404f71e-3ac4-4176-8a04-dd7f8e90450a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c233c47dc61d085ed417f2f5bfe7c2e86edc861a71a1195ad1d96f22de9e2290"
        }
    ]
}