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/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/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/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449685/?format=api",
            "id": 449685,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d882d631-b81a-475e-b0d1-16b35f9be517/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010631Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8c1d8b1d8590ea30e2be32a337e5e9c9743f6a287e2f5d423fec7508bfc6608a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449755/?format=api",
            "id": 449755,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/8787be8c-bd4b-48f7-8c69-82c6da144876/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010631Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=54153eafa65aecf558fccd35a9e4956c54ec8bb852e283b4c9e7db7b496163cd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449764/?format=api",
            "id": 449764,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449764/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449774/?format=api",
            "id": 449774,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/84d38b18-ff7b-473e-bb7f-3908d8f0a994/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010631Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4f859f031c47608b784dd7a90d6bb6e776f2ef45ee12950865b6675ef5489dad"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449775/?format=api",
            "id": 449775,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/567f6e79-540e-400e-8108-96b524a5e5d9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010631Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=09f1b45ba8083252622ae657745d046ef6c88f8162bbe8478cf48025d2008d0a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449776/?format=api",
            "id": 449776,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/add004e1-cbee-467a-9603-8ee1f649d334/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010631Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e643124ac278a094addd351c7c8f0a3e850da2d1339056f7deeb5d2b78f23791"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449777/?format=api",
            "id": 449777,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0154905b-d136-4d2b-b9ab-043e1c235fd1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010631Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8618e7ac11b09758982b879c80d2445293a7da9899c0cce77ff3502159ac8a24"
        }
    ]
}