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/4452e49a-f37d-4d7f-8f18-fce463172051/results/?format=api

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

{
    "count": 12,
    "next": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494578/?format=api",
            "id": 494578,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/gridadmin.h5?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=97fa84d65d4be04b2ed3b70af146934e72a78a0f3407f9608103b2ec0772e6dc",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494579/?format=api",
            "id": 494579,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results_3di.nc?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6d8e8795f1c06375509e443b45348bc4a4e21823c43f794702125fecf56958bb",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494580/?format=api",
            "id": 494580,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/log_files.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=90a3e53fddec17b1ed6697887ac26d75da9505a4edcc2e7c9683e3f82f6b77f8",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494581/?format=api",
            "id": 494581,
            "name": "Aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/aggregate_results_3di.nc?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1d9f9e01d3a33247d8e2fcd41db084174d9718da640471b292c3b7a5abe736ae",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494582/?format=api",
            "id": 494582,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/74dbba5d-225b-4228-96b3-b6b920820133/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3189ee7385c3db03911422b7303e6c1e7a43180f459e7427bffa300accee2bfa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494583/?format=api",
            "id": 494583,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/976e4870-de97-43ac-b72d-9d4db3176b30/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eda91e4463d744014601d73c6cb5787a92c02928866e030d9eb1d87c7e433780"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494584/?format=api",
            "id": 494584,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/68e44d66-04d2-480b-a772-997ae0365137/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3a83d28bbd10d1b4098a5d9938b7495fbc2fcab90b71db37a81a24a51a0e2d4f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494585/?format=api",
            "id": 494585,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3af319f7-5b2d-4065-9ea4-701522892f22/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=72c25e36363d638350fbbb1c57c0894ba5f585e394549b17491ac244990b9081"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494586/?format=api",
            "id": 494586,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/341d6b1e-1572-4ead-93f4-575d5fec5e51/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9c4c9b8bd312cab0f5c2b06e8f6836a24163dbe3d77f3f2d83de0c0f26cb4653"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494587/?format=api",
            "id": 494587,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5838a244-bda5-41ce-8f0d-0105b820be2b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001612Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2ef3c9685df9eb99d5ca9b1c2739e3c5247bdcad89e9d6f16e318ac2f38e4fc4"
        }
    ]
}