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=16
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 164,
    "next": "https://demo.lizard.net/api/v4/scenarios/?format=api&page=17",
    "previous": "https://demo.lizard.net/api/v4/scenarios/?format=api&page=15",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/df07d8ec-0ca9-4428-8fa4-bcb13062d68f/?format=api",
            "uuid": "df07d8ec-0ca9-4428-8fa4-bcb13062d68f",
            "name": "zwaagdijk_60mm1u_rev11_v2",
            "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": "2021-12-23T15:05:38.827388Z",
            "last_modified": "2022-07-20T09:37:55.966400Z",
            "simulation_identifier": "53622",
            "simulation_start": "2020-01-01T07:00:00Z",
            "simulation_end": "2020-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7358",
            "model_name": "r0176_medemblik_zwaagdijk-zwaagdijk_default-11-1d8ed2a72f90e582f85d3fa93990fd13601082f4",
            "has_raw_results": true,
            "total_size": 221207119,
            "spatial_bounds": {
                "west": 5.11625512386991,
                "east": 5.16042067641741,
                "north": 52.7143518638958,
                "south": 52.6884182647779
            },
            "projection": "EPSG:28992",
            "origin_x": 136690.5,
            "origin_y": 522366.5,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 139666.0,
            "upper_bound_y": 525242.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8cbc1a53-e518-4a4a-901f-9be440d95bd3/?format=api",
            "uuid": "8cbc1a53-e518-4a4a-901f-9be440d95bd3",
            "name": "r0176_Medemblik_Zwaagdijk_bui08jup_loop",
            "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": "2021-12-23T12:32:47.320684Z",
            "last_modified": "2022-07-20T09:37:08.684377Z",
            "simulation_identifier": "53550",
            "simulation_start": "2021-01-01T07:00:00Z",
            "simulation_end": "2021-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7358",
            "model_name": "r0176_medemblik_zwaagdijk-zwaagdijk_default-11-1d8ed2a72f90e582f85d3fa93990fd13601082f4",
            "has_raw_results": true,
            "total_size": 235364960,
            "spatial_bounds": {
                "west": 5.11625512386991,
                "east": 5.16042067641741,
                "north": 52.7143518638958,
                "south": 52.6884182647779
            },
            "projection": "EPSG:28992",
            "origin_x": 136690.5,
            "origin_y": 522366.5,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 139666.0,
            "upper_bound_y": 525242.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/729685f4-8473-44c5-8c9c-03dff83146f9/?format=api",
            "uuid": "729685f4-8473-44c5-8c9c-03dff83146f9",
            "name": "nibbixwoud_bui08_rev7_v2",
            "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": "2021-12-23T11:57:37.280439Z",
            "last_modified": "2022-07-12T06:58:10.826484Z",
            "simulation_identifier": "53593",
            "simulation_start": "2020-01-01T07:00:00Z",
            "simulation_end": "2020-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7937",
            "model_name": "r0176_medemblik_nibbixwoud-nibbixwoud_default-7-4f628782c82b03b91d8d412f2579d6c76e881b48",
            "has_raw_results": true,
            "total_size": 588164463,
            "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/57bde6d8-b033-4918-8cb1-a5f13d65e86c/?format=api",
            "uuid": "57bde6d8-b033-4918-8cb1-a5f13d65e86c",
            "name": "midwoud_bui08_rev5_v2",
            "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": "2021-12-23T10:39:12.895107Z",
            "last_modified": "2022-07-12T06:57:09.311481Z",
            "simulation_identifier": "53587",
            "simulation_start": "2020-01-01T07:00:00Z",
            "simulation_end": "2020-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7944",
            "model_name": "r0176_medemblik_midwoud-midwoud_default-5-e6a989d5437d7f9d5d7a0e553829bb59c88f4c80",
            "has_raw_results": true,
            "total_size": 253434535,
            "spatial_bounds": {
                "west": 5.05244487158944,
                "east": 5.10702321614057,
                "north": 52.7327688524149,
                "south": 52.6940395040162
            },
            "projection": "EPSG:28992",
            "origin_x": 132388.0,
            "origin_y": 523010.0,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 136058.0,
            "upper_bound_y": 527304.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b805fd45-adc4-4445-b28d-ad53db5f1deb/?format=api",
            "uuid": "b805fd45-adc4-4445-b28d-ad53db5f1deb",
            "name": "r0176_Medemblik_Zwaagdijk_bui09jup_loop",
            "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": "2021-12-23T06:34:45.103204Z",
            "last_modified": "2022-07-20T09:36:31.439116Z",
            "simulation_identifier": "53551",
            "simulation_start": "2021-01-01T07:00:00Z",
            "simulation_end": "2021-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7358",
            "model_name": "r0176_medemblik_zwaagdijk-zwaagdijk_default-11-1d8ed2a72f90e582f85d3fa93990fd13601082f4",
            "has_raw_results": true,
            "total_size": 218290125,
            "spatial_bounds": {
                "west": 5.11625512386991,
                "east": 5.16042067641741,
                "north": 52.7143518638958,
                "south": 52.6884182647779
            },
            "projection": "EPSG:28992",
            "origin_x": 136690.5,
            "origin_y": 522366.5,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 139666.0,
            "upper_bound_y": 525242.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ae11d10a-8a9b-4e8e-b78b-d1ad367dbb4a/?format=api",
            "uuid": "ae11d10a-8a9b-4e8e-b78b-d1ad367dbb4a",
            "name": "r0176_Medemblik_Midwoud_160mm_2ujup_loop",
            "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": "2021-12-22T20:02:06.569016Z",
            "last_modified": "2022-06-10T12:35:07.489635Z",
            "simulation_identifier": "53488",
            "simulation_start": "2021-01-01T07:00:00Z",
            "simulation_end": "2021-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7944",
            "model_name": "r0176_medemblik_midwoud-midwoud_default-5-e6a989d5437d7f9d5d7a0e553829bb59c88f4c80",
            "has_raw_results": true,
            "total_size": 271994386,
            "spatial_bounds": {
                "west": 5.05244487158944,
                "east": 5.10702321614057,
                "north": 52.7327688524149,
                "south": 52.6940395040162
            },
            "projection": "EPSG:28992",
            "origin_x": 132388.0,
            "origin_y": 523010.0,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 136058.0,
            "upper_bound_y": 527304.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d04ecb16-0745-4acf-b189-883b17c3f4ea/?format=api",
            "uuid": "d04ecb16-0745-4acf-b189-883b17c3f4ea",
            "name": "r0176_Medemblik_Midwoud_60mm_1ujup_loop",
            "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": "2021-12-22T19:52:08.317295Z",
            "last_modified": "2022-05-30T06:55:17.908111Z",
            "simulation_identifier": "53486",
            "simulation_start": "2021-01-01T07:00:00Z",
            "simulation_end": "2021-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7944",
            "model_name": "r0176_medemblik_midwoud-midwoud_default-5-e6a989d5437d7f9d5d7a0e553829bb59c88f4c80",
            "has_raw_results": true,
            "total_size": 263039426,
            "spatial_bounds": {
                "west": 5.05244487158944,
                "east": 5.10702321614057,
                "north": 52.7327688524149,
                "south": 52.6940395040162
            },
            "projection": "EPSG:28992",
            "origin_x": 132388.0,
            "origin_y": 523010.0,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 136058.0,
            "upper_bound_y": 527304.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d6a0093b-052e-4740-b42f-cf2a35010f78/?format=api",
            "uuid": "d6a0093b-052e-4740-b42f-cf2a35010f78",
            "name": "r0176_Medemblik_Midwoud_bui09jup_loop",
            "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": "2021-12-22T19:49:21.871549Z",
            "last_modified": "2022-05-16T08:57:37.733316Z",
            "simulation_identifier": "53485",
            "simulation_start": "2021-01-01T07:00:00Z",
            "simulation_end": "2021-01-01T11:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7944",
            "model_name": "r0176_medemblik_midwoud-midwoud_default-5-e6a989d5437d7f9d5d7a0e553829bb59c88f4c80",
            "has_raw_results": true,
            "total_size": 257405121,
            "spatial_bounds": {
                "west": 5.05244487158944,
                "east": 5.10702321614057,
                "north": 52.7327688524149,
                "south": 52.6940395040162
            },
            "projection": "EPSG:28992",
            "origin_x": 132388.0,
            "origin_y": 523010.0,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 136058.0,
            "upper_bound_y": 527304.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1f438391-aaea-416b-9051-e612452bdc3c/?format=api",
            "uuid": "1f438391-aaea-416b-9051-e612452bdc3c",
            "name": "W080_Fryslan_Stavoren_rev13_t4000",
            "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": "2021-12-16T11:17:12.845513Z",
            "last_modified": "2021-12-17T07:37:59.631631Z",
            "simulation_identifier": "52567",
            "simulation_start": "2000-01-01T00:00:00Z",
            "simulation_end": "2000-01-03T00:00:00Z",
            "supplier": "martine.rottink",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7904",
            "model_name": "fryslan-zuidwest-wf_zw_052_zw_2d_052-13-8c26882a6854e38f07f5b4611b467e8fdd8309e0",
            "has_raw_results": true,
            "total_size": 1320588988,
            "spatial_bounds": {
                "west": 5.35102245145069,
                "east": 5.72458830689215,
                "north": 53.0580781274159,
                "south": 52.8316593649618
            },
            "projection": "EPSG:28992",
            "origin_x": 152574.0,
            "origin_y": 538324.0,
            "pixelsize_x": 2.0,
            "pixelsize_y": -2.0,
            "upper_bound_x": 177620.0,
            "upper_bound_y": 563468.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/89c54bfd-feaa-4b0f-91ac-941d0401f5a4/?format=api",
            "uuid": "89c54bfd-feaa-4b0f-91ac-941d0401f5a4",
            "name": "W080_Fryslan_Oostbierum_rev10_t4000",
            "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": "2021-12-15T17:06:22.520623Z",
            "last_modified": "2021-12-16T12:43:53.506388Z",
            "simulation_identifier": "52483",
            "simulation_start": "2000-01-01T00:00:00Z",
            "simulation_end": "2000-01-04T18:00:00Z",
            "supplier": "martine.rottink",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "7903",
            "model_name": "fryslan-noordwest-wf_nw_052_nw_2d_052-10-c0157bbb25ec9ac377d5934ff3779d7cb6fcb37b",
            "has_raw_results": true,
            "total_size": 1419897178,
            "spatial_bounds": {
                "west": 5.37740109604369,
                "east": 5.85923515293317,
                "north": 53.3257243319726,
                "south": 53.0075756102004
            },
            "projection": "EPSG:28992",
            "origin_x": 154346.54779321,
            "origin_y": 557949.528398848,
            "pixelsize_x": 3.0,
            "pixelsize_y": -3.0,
            "upper_bound_x": 186452.54779321,
            "upper_bound_y": 593253.528398848
        }
    ]
}