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/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/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/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454719/?format=api",
            "id": 454719,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/99843594-210e-4bf4-8aa6-2ed4753e9fb5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062244Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=956bcf18dfd3388c333de6b5fcd23dff70fec38ee419c874924ff8b402a029a4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454720/?format=api",
            "id": 454720,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/a7639033-afcd-4186-a6f3-8fac42b076b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062244Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ff38a312190843bfa7edbd33a739731872f6c04106e9a0f89bc9b56825759f17"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454733/?format=api",
            "id": 454733,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454733/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454759/?format=api",
            "id": 454759,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/07b1f7a0-4379-4c4f-923c-1ffe0f922033/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062244Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dbba103ab654010991793493343cf9a8e895be2209493709e707c1a42d2060d1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454760/?format=api",
            "id": 454760,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/16ea524d-126b-4e74-9e64-e9aa266d9bdd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062244Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=be0d0490494dc9d07d80969b3159e72427ea145be8103b387d839d80d7fb4c36"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454761/?format=api",
            "id": 454761,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee9b9ee2-f25e-4b8c-aae2-dcadc226e94b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062244Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b82db005d352aeef591b7f958ebe147a978cb8aefc1b95e5218f32894a296bd4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454762/?format=api",
            "id": 454762,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e5d57566-5ae6-40af-9439-df78ec6cb410/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062244Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9ffb0ee37b3639f43983b3c5779b6dfeef9b268925c73e26dec96666bdf7c37d"
        }
    ]
}