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/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/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/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454883/?format=api",
            "id": 454883,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0802f4cb-3ee7-476c-82d3-6dc443cd97ba/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T031522Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4d1fda5f6430362abce3ecf0151b1cd6f6094dfc85a786834b4e613971bf287e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454884/?format=api",
            "id": 454884,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/bb4ba727-c049-41ce-8446-1fbcfd6c8965/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T031522Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6af54aa128968f4310b3a40d30316a580a46317205d65b828bfc634798b4adba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454885/?format=api",
            "id": 454885,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454885/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454906/?format=api",
            "id": 454906,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/929c808c-38ac-43b7-9e6d-c87357e8ad84/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T031522Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ebc9898518338a22242f619c2242af6204b6b0b93fb38068371d0f5c346b2603"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454907/?format=api",
            "id": 454907,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/478f5203-8af6-4f74-a280-5946ba0f7cc6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T031522Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=06cd65bfb7a0763440a87269c752cebf667e3000a5c45fff6dc10b4b2a4f825a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454908/?format=api",
            "id": 454908,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8567e4cc-0b3e-4105-beec-6e4627494155/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T031522Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9cabebe4a1eb35cfffc3860304fd22aeec1df1bef7fbffe42d538fa9b0e8a666"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454909/?format=api",
            "id": 454909,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f4906bd3-4a2c-4b63-8ce7-c615b82629a9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T031522Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5451532889b19677893f9d1e89d22aca49e5eefdb02576b420d6162fdf648a2f"
        }
    ]
}