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/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/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/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448186/?format=api",
            "id": 448186,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a805edf8-1e6b-48cb-862f-1a7a6ea545cb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0e3377797aac94e1802f08aabe770dec1b11967a668cee03973c58b30098d8f1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448187/?format=api",
            "id": 448187,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/8801c5c8-ef34-4012-ae15-36049d39eb23/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4a0f11d2ae5f2d739fdc90acb22ae59ff11e31d34591c894d08724ef387121e0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448188/?format=api",
            "id": 448188,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448188/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448189/?format=api",
            "id": 448189,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5bace318-c6ce-42c5-9a35-4f23e61a9f2f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dc846e4275628cc2cd37c5c14e34fbcd73dbcded29594fa75fb8c15ae8026878"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448190/?format=api",
            "id": 448190,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2f93263f-2e83-4fa8-af1a-d4a8628c5b4e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=63c537f5a3bd4571b52a96f1cde075873c9c93aed9bf6595eab5021f0efd00b3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448191/?format=api",
            "id": 448191,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a382938e-78dd-4961-8e2c-9ab897ca2860/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8cd6e35e775530d8a3d75e44fb34c44c3bcd35563df4e77c53b065bfc39f8ae0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448192/?format=api",
            "id": 448192,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/6a96cec2-2aec-466f-9301-0b7f7f358d00/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f4c7d5c824b72f914b68d5f686297d7f8fd6ac75a985712a4c02702fcc654784"
        }
    ]
}