Endpoint for interacting with 3Di scenarios.

Subendpoints

Scenario results are available via /api/v4/scenarios/{uuid}/results/. Here, {uuid} should be replaced with the scenario's uuid.

Basic result processing can be started for a raw 3Di result via /api/v4/scenarios/{uuid}/process.

These subendpoints, as well as more detailed documentation about the endpoints, are also available via the "Extra Actions" button in the top-right corner when viewing a scenario instance on /api/v4/scenarios/{uuid}/.

Query parameters

name Text filter on the name field. Supports the following lookups: exact, startswith, icontains, and isnull.

uuid Filter on the uuid field, supports exact lookups only.

organisation Filter on organisation.

project Filter on the project's name, code, or uuid. The name and code support all text field filter methods: startswith, endswith, icontains, etc. The uuid field only supports exact lookups.

extra_metadata Filter on extra_metadata. Filter statements are given as a json dictionary whose keys are filter statements, and the values of the dictionary are the values to filter on. All filter methods are supported, also on nested elements of the field.

model_name Text filter on the model_name field. Supports the following lookups: exact, startswith, icontains, and isnull.

supplier Related field text filter on the username and email fields of supplier. For these fields, the following lookups are supported: exact, startswith, icontains, and isnull. Additionally, the isnull filter is supported on the supplier field itself.

access_modifier Filter on access_modifier, options are 'Public', 'Private', 'Common', or 'Hidden'.

ordering Show the results in a specific order. You can order them by created, last_modified, name, organisation__name, username, model_name or total_size. Add a - in front to reverse the order.

created: Temporal filter on created. Supports various lookup types (exact, lt, lte, gt, gte; created__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

last_modified: Temporal filter on last_modified. Supports various lookup types (exact, lt, lte, gt, gte; last_modified__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

Examples:

?name=What

?name__icontains=wha

?name__startswith=wha

?extra_metadata={"comment__icontains": "water", "number__gte": "5", "nested_field__number__lte": "5"}

?uuid=e7a8

?uuid=10415ccb-ec31-4d43-bdb3-db597061527b

?uuid=88F7-4C9F-8F28,15EA-4B7F-B2ED

?organisation__name__startswith=Nelen

?organisation__name=DDSC

?organisation__name__startswith=Nelen

?organisation__name__icontains=Schuur

?organisation__uuid=61f5a464c35044c19bc7d4b42d7f58cb

?project__name=project_name

?project__name__icontains=PROJECT_name

?project__code=project_code_1234

?project__code__icontains=CODE_1234

?project__uuid=e1518dd0-254a-414f-a69e-8434a8a89e0a

?model_revision__icontains=em

?model_name__endswith=em

?supplier__username__icontains=em

?supplier__email=user@nelen-schuurmans.com

?supplier__isnull=true

?access_modifier=Private

?access_modifier=100

?ordering=name

?ordering=-created

?created__gte=2017-01-01T00:00:00Z

?last_modified__lt=2018-01-01T00:00:00Z
GET /api/v4/scenarios/?format=api&page=15
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 161,
    "next": "https://demo.lizard.net/api/v4/scenarios/?format=api&page=16",
    "previous": "https://demo.lizard.net/api/v4/scenarios/?format=api&page=14",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7c734008-4109-43b3-865d-67e7882499b4/?format=api",
            "uuid": "7c734008-4109-43b3-865d-67e7882499b4",
            "name": "Eygelshoven - Maatregel E rev 1 T100",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-02-15T22:59:59.568389Z",
            "last_modified": "2022-02-17T08:08:59.865141Z",
            "simulation_identifier": "60939",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38416",
            "model_name": "eygelshoven-maatregel-e-1",
            "has_raw_results": true,
            "total_size": 275922672,
            "spatial_bounds": {
                "west": 5.98973471512778,
                "east": 6.09450499668432,
                "north": 50.9237400609111,
                "south": 50.8278604530771
            },
            "projection": "EPSG:28992",
            "origin_x": 197453.973783605,
            "origin_y": 315572.828400738,
            "pixelsize_x": 2.0,
            "pixelsize_y": -2.0,
            "upper_bound_x": 204733.973783605,
            "upper_bound_y": 326174.828400738
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/?format=api",
            "uuid": "f7791ba4-9acf-4bc9-aef3-516343150df7",
            "name": "Eygelshoven - Maatregel C rev 1 T100",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-02-15T22:48:59.479002Z",
            "last_modified": "2022-02-17T08:08:20.090681Z",
            "simulation_identifier": "60936",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38414",
            "model_name": "eygelshoven-maatregel-c-1",
            "has_raw_results": true,
            "total_size": 298611919,
            "spatial_bounds": {
                "west": 5.98973471512778,
                "east": 6.09450499668432,
                "north": 50.9237400609111,
                "south": 50.8278604530771
            },
            "projection": "EPSG:28992",
            "origin_x": 197453.973783605,
            "origin_y": 315572.828400738,
            "pixelsize_x": 2.0,
            "pixelsize_y": -2.0,
            "upper_bound_x": 204733.973783605,
            "upper_bound_y": 326174.828400738
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/feb3923f-4337-498e-9a6f-deb7a09d431d/?format=api",
            "uuid": "feb3923f-4337-498e-9a6f-deb7a09d431d",
            "name": "Eygelshoven - Maatregel B rev 1 T100",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-02-15T22:48:30.372358Z",
            "last_modified": "2022-02-17T08:30:37.789623Z",
            "simulation_identifier": "60935",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38412",
            "model_name": "eygelshoven-maatregel-b-1",
            "has_raw_results": true,
            "total_size": 298602187,
            "spatial_bounds": {
                "west": 5.98973471512778,
                "east": 6.09450499668432,
                "north": 50.9237400609111,
                "south": 50.8278604530771
            },
            "projection": "EPSG:28992",
            "origin_x": 197453.973783605,
            "origin_y": 315572.828400738,
            "pixelsize_x": 2.0,
            "pixelsize_y": -2.0,
            "upper_bound_x": 204733.973783605,
            "upper_bound_y": 326174.828400738
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/?format=api",
            "uuid": "e4f63032-4d58-44ef-9fc5-697c6e5ee21f",
            "name": "Eygelshoven - Verwacht rev 2 T100",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-02-15T22:48:15.989302Z",
            "last_modified": "2022-02-17T08:27:31.825887Z",
            "simulation_identifier": "60933",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38410",
            "model_name": "eygelshoven-verwacht-2",
            "has_raw_results": true,
            "total_size": 298605132,
            "spatial_bounds": {
                "west": 5.98973471512778,
                "east": 6.09450499668432,
                "north": 50.9237400609111,
                "south": 50.8278604530771
            },
            "projection": "EPSG:28992",
            "origin_x": 197453.973783605,
            "origin_y": 315572.828400738,
            "pixelsize_x": 2.0,
            "pixelsize_y": -2.0,
            "upper_bound_x": 204733.973783605,
            "upper_bound_y": 326174.828400738
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/?format=api",
            "uuid": "21fe7c29-6ef5-4bd1-866d-9b48ff1c2015",
            "name": "Eygelshoven - Maatregel A rev 1 T100",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-02-15T22:48:09.143690Z",
            "last_modified": "2022-02-17T08:27:10.813415Z",
            "simulation_identifier": "60934",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38411",
            "model_name": "eygelshoven-maatregel-a-1",
            "has_raw_results": true,
            "total_size": 298610828,
            "spatial_bounds": {
                "west": 5.98973471512778,
                "east": 6.09450499668432,
                "north": 50.9237400609111,
                "south": 50.8278604530771
            },
            "projection": "EPSG:28992",
            "origin_x": 197453.973783605,
            "origin_y": 315572.828400738,
            "pixelsize_x": 2.0,
            "pixelsize_y": -2.0,
            "upper_bound_x": 204733.973783605,
            "upper_bound_y": 326174.828400738
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/?format=api",
            "uuid": "4f5a4919-4a90-45ef-afc0-3d58061966ed",
            "name": "Eygelshoven - Maatregel D rev 1 T100",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-02-15T22:46:02.445391Z",
            "last_modified": "2022-02-17T08:08:35.827511Z",
            "simulation_identifier": "60938",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38415",
            "model_name": "eygelshoven-maatregel-d-1",
            "has_raw_results": true,
            "total_size": 298602737,
            "spatial_bounds": {
                "west": 5.98973471512778,
                "east": 6.09450499668432,
                "north": 50.9237400609111,
                "south": 50.8278604530771
            },
            "projection": "EPSG:28992",
            "origin_x": 197453.973783605,
            "origin_y": 315572.828400738,
            "pixelsize_x": 2.0,
            "pixelsize_y": -2.0,
            "upper_bound_x": 204733.973783605,
            "upper_bound_y": 326174.828400738
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/?format=api",
            "uuid": "e590d9ea-3c4d-4bd2-b679-6916275aa5bf",
            "name": "Eygelshoven - Huidig-verbeterd rev 2 T100",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-02-15T22:44:59.217436Z",
            "last_modified": "2022-02-17T08:27:20.464103Z",
            "simulation_identifier": "60931",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38409",
            "model_name": "eygelshoven-huidig-verbeterd-2",
            "has_raw_results": true,
            "total_size": 298616076,
            "spatial_bounds": {
                "west": 5.98973471512778,
                "east": 6.09450499668432,
                "north": 50.9237400609111,
                "south": 50.8278604530771
            },
            "projection": "EPSG:28992",
            "origin_x": 197453.973783605,
            "origin_y": 315572.828400738,
            "pixelsize_x": 2.0,
            "pixelsize_y": -2.0,
            "upper_bound_x": 204733.973783605,
            "upper_bound_y": 326174.828400738
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c5bbac59-291a-4f21-92c8-3ada6749d67d/?format=api",
            "uuid": "c5bbac59-291a-4f21-92c8-3ada6749d67d",
            "name": "w0159_burundi_r23_70mm_2h_10hdry",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-01-24T12:38:56.811468Z",
            "last_modified": "2022-01-24T13:35:06.402246Z",
            "simulation_identifier": "57497",
            "simulation_start": "2020-12-31T23:00:00Z",
            "simulation_end": "2021-01-01T16:00:00Z",
            "supplier": "maud.vandelden",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "8332",
            "model_name": "w0159-burundi-slamdam_burundi_slamdam-23-3342be966b423ad6d1bb465f2a070764775455a2",
            "has_raw_results": true,
            "total_size": 366925834,
            "spatial_bounds": {
                "west": 29.2949918865156,
                "east": 29.5666424284334,
                "north": -3.01666666666665,
                "south": -3.29642583175997
            },
            "projection": "EPSG:3857",
            "origin_x": 3261103.5796,
            "origin_y": -367159.056583925,
            "pixelsize_x": 10.0,
            "pixelsize_y": -10.0,
            "upper_bound_x": 3291343.5796,
            "upper_bound_y": -335969.056583925
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1bdd7909-e820-4e63-9735-19ee0166b816/?format=api",
            "uuid": "1bdd7909-e820-4e63-9735-19ee0166b816",
            "name": "Medemblik_nibbixwoud_rev9_60mm_1u",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-01-04T15:24:50.642346Z",
            "last_modified": "2022-07-12T10:23:09.805206Z",
            "simulation_identifier": "54980",
            "simulation_start": "2020-01-01T07:00:00Z",
            "simulation_end": "2020-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "8052",
            "model_name": "r0176_medemblik_nibbixwoud-nibbixwoud_default-9-b15071496fd85573e6bd8fcf4d095f4205fb8e42",
            "has_raw_results": true,
            "total_size": 614164702,
            "spatial_bounds": {
                "west": 4.98066612184446,
                "east": 5.08525361059667,
                "north": 52.7063839967899,
                "south": 52.6707241098383
            },
            "projection": "EPSG:28992",
            "origin_x": 127523.0,
            "origin_y": 520440.5,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 134575.5,
            "upper_bound_y": 524374.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/89555c7a-1207-4299-afa2-ddf0dd46bb94/?format=api",
            "uuid": "89555c7a-1207-4299-afa2-ddf0dd46bb94",
            "name": "Medemblik_nibbixwoud_rev9_bui09",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2022-01-04T15:21:47.556876Z",
            "last_modified": "2022-07-12T10:09:08.867775Z",
            "simulation_identifier": "54979",
            "simulation_start": "2020-01-01T07:00:00Z",
            "simulation_end": "2020-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "8052",
            "model_name": "r0176_medemblik_nibbixwoud-nibbixwoud_default-9-b15071496fd85573e6bd8fcf4d095f4205fb8e42",
            "has_raw_results": true,
            "total_size": 597603057,
            "spatial_bounds": {
                "west": 4.98066612184446,
                "east": 5.08525361059667,
                "north": 52.7063839967899,
                "south": 52.6707241098383
            },
            "projection": "EPSG:28992",
            "origin_x": 127523.0,
            "origin_y": 520440.5,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 134575.5,
            "upper_bound_y": 524374.0
        }
    ]
}