Scenario List
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=11
{ "count": 164, "next": "https://demo.lizard.net/api/v4/scenarios/?format=api&page=12", "previous": "https://demo.lizard.net/api/v4/scenarios/?format=api&page=10", "results": [ { "url": "https://demo.lizard.net/api/v4/scenarios/74c64fb6-a8e2-4f3a-96fe-6e480459de67/?format=api", "uuid": "74c64fb6-a8e2-4f3a-96fe-6e480459de67", "name": "test_tuflow", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/7cc5c566-d653-470e-9e02-ff5c3b3a758b/?format=api", "uuid": "7cc5c566-d653-470e-9e02-ff5c3b3a758b", "name": "HVFMS" }, "project": null, "description": "test scenario", "extra_metadata": {}, "access_modifier": "Public", "created": "2022-07-20T09:51:40.522779Z", "last_modified": "2022-07-20T09:51:40.522768Z", "simulation_identifier": null, "simulation_start": "2022-07-20T00:00:00Z", "simulation_end": "2022-07-20T12:00:00Z", "supplier": null, "source": "tuflow", "model_identifier": null, "model_revision": "1", "model_name": "hvfms", "has_raw_results": false, "total_size": 0, "spatial_bounds": null, "projection": null, "origin_x": null, "origin_y": null, "pixelsize_x": null, "pixelsize_y": null, "upper_bound_x": null, "upper_bound_y": null }, { "url": "https://demo.lizard.net/api/v4/scenarios/bfebf76a-78c7-414e-92e2-8715db78b87b/?format=api", "uuid": "bfebf76a-78c7-414e-92e2-8715db78b87b", "name": "Wervershoof_Maatregelen_rev2_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-07-12T07:39:35.623594Z", "last_modified": "2022-07-20T08:33:50.168609Z", "simulation_identifier": "82587", "simulation_start": "2000-01-01T07:00:00Z", "simulation_end": "2000-01-01T11:00:00Z", "supplier": "marleen.ketelaars", "source": "3Di", "model_identifier": "41548", "model_revision": "39654", "model_name": "ssw-medemblik-maatregelmodel-wervershoof-2", "has_raw_results": true, "total_size": 214014944, "spatial_bounds": { "west": 5.12195713835716, "east": 5.17368510069846, "north": 52.752799633089, "south": 52.7238216296069 }, "projection": "EPSG:28992", "origin_x": 137091.5, "origin_y": 526304.5, "pixelsize_x": 0.5, "pixelsize_y": -0.5, "upper_bound_x": 140574.5, "upper_bound_y": 529517.5 }, { "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/?format=api", "uuid": "c31ee575-0408-4261-8c67-82b50e11f118", "name": "medemblik_rev15_bui09_1h_referentie", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/bf5b7a0b-c350-4489-a4f0-191e6d9e87f7/?format=api", "uuid": "bf5b7a0b-c350-4489-a4f0-191e6d9e87f7", "name": "3Di test" }, "project": null, "description": "", "extra_metadata": {}, "access_modifier": "Public", "created": "2022-06-20T08:11:58.460957Z", "last_modified": "2022-07-12T10:06:54.617833Z", "simulation_identifier": "78714", "simulation_start": "2000-01-01T06:00:00Z", "simulation_end": "2000-01-01T10:00:00Z", "supplier": "noortje.oosterhoff", "source": "3Di", "model_identifier": "42733", "model_revision": "39847", "model_name": "medemblik_medemblik-medemblik_default-1-15", "has_raw_results": true, "total_size": 182499176, "spatial_bounds": { "west": 5.08500918742591, "east": 5.12102660493779, "north": 52.7744192048636, "south": 52.7546259010367 }, "projection": "EPSG:28992", "origin_x": 134607.0, "origin_y": 529742.0, "pixelsize_x": 0.5, "pixelsize_y": -0.5, "upper_bound_x": 137029.5, "upper_bound_y": 531935.0 }, { "url": "https://demo.lizard.net/api/v4/scenarios/011479e5-43c4-4788-bb7f-3794d9aeccfc/?format=api", "uuid": "011479e5-43c4-4788-bb7f-3794d9aeccfc", "name": "Nibbixwoud_Maatregelen_rev2_Bui08", "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-04-26T12:54:01.656904Z", "last_modified": "2022-07-20T08:28:55.974030Z", "simulation_identifier": "71042", "simulation_start": "2000-01-01T12:00:00Z", "simulation_end": "2000-01-01T16:00:00Z", "supplier": "marleen.ketelaars", "source": "3Di", "model_identifier": null, "model_revision": "39484", "model_name": "ssw-medemblik-maatregelmodel-nibbixwoud-2", "has_raw_results": true, "total_size": 528701587, "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/1b85f3f2-da19-4973-aa38-8d582849adba/?format=api", "uuid": "1b85f3f2-da19-4973-aa38-8d582849adba", "name": "Wervershoof_Maatregelen_rev2_Bui08", "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-04-26T12:52:14.621967Z", "last_modified": "2022-07-12T07:11:58.012403Z", "simulation_identifier": "71050", "simulation_start": "2000-01-01T12:00:00Z", "simulation_end": "2000-01-01T16:00:00Z", "supplier": "marleen.ketelaars", "source": "3Di", "model_identifier": null, "model_revision": "39654", "model_name": "ssw-medemblik-maatregelmodel-wervershoof-2", "has_raw_results": true, "total_size": 209779695, "spatial_bounds": { "west": 5.12195713835716, "east": 5.17368510069846, "north": 52.752799633089, "south": 52.7238216296069 }, "projection": "EPSG:28992", "origin_x": 137091.5, "origin_y": 526304.5, "pixelsize_x": 0.5, "pixelsize_y": -0.5, "upper_bound_x": 140574.5, "upper_bound_y": 529517.5 }, { "url": "https://demo.lizard.net/api/v4/scenarios/c86682df-7030-4633-a851-ce396c7b23ef/?format=api", "uuid": "c86682df-7030-4633-a851-ce396c7b23ef", "name": "Opperdoes_Maatregelen_rev1_Bui08", "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-04-26T12:48:58.266362Z", "last_modified": "2022-07-20T08:30:58.879515Z", "simulation_identifier": "71046", "simulation_start": "2000-01-01T12:00:00Z", "simulation_end": "2000-01-01T16:00:00Z", "supplier": "marleen.ketelaars", "source": "3Di", "model_identifier": null, "model_revision": "39366", "model_name": "ssw-medemblik-maatregelmodel-opperdoes-1", "has_raw_results": true, "total_size": 323388611, "spatial_bounds": { "west": 5.02687916774007, "east": 5.09276890238431, "north": 52.7686367369639, "south": 52.7263899910129 }, "projection": "EPSG:28992", "origin_x": 130681.0, "origin_y": 526618.0, "pixelsize_x": 0.5, "pixelsize_y": -0.5, "upper_bound_x": 135109.0, "upper_bound_y": 531299.0 }, { "url": "https://demo.lizard.net/api/v4/scenarios/ad2bd070-3afa-4afd-93d1-cdf2b2b417eb/?format=api", "uuid": "ad2bd070-3afa-4afd-93d1-cdf2b2b417eb", "name": "Medemblik_Maatregelen_rev3_Bui08", "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-04-26T12:47:56.875590Z", "last_modified": "2022-07-20T09:07:47.224928Z", "simulation_identifier": "71044", "simulation_start": "2000-01-01T12:00:00Z", "simulation_end": "2000-01-01T16:00:00Z", "supplier": "marleen.ketelaars", "source": "3Di", "model_identifier": null, "model_revision": "39430", "model_name": "ssw-medemblik-maatregelmodel-medemblik-3", "has_raw_results": true, "total_size": 179467635, "spatial_bounds": { "west": 5.08500918742591, "east": 5.12102660493779, "north": 52.7744192048636, "south": 52.7546259010367 }, "projection": "EPSG:28992", "origin_x": 134607.0, "origin_y": 529742.0, "pixelsize_x": 0.5, "pixelsize_y": -0.5, "upper_bound_x": 137029.5, "upper_bound_y": 531935.0 }, { "url": "https://demo.lizard.net/api/v4/scenarios/80ef992d-f8c4-44d1-8cab-c7087b27c6b7/?format=api", "uuid": "80ef992d-f8c4-44d1-8cab-c7087b27c6b7", "name": "Midwoud_Maatregelen_rev2_Bui08", "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-04-26T11:15:14.489991Z", "last_modified": "2022-05-13T06:20:57.908660Z", "simulation_identifier": "70813", "simulation_start": "2000-01-01T12:00:00Z", "simulation_end": "2000-01-01T16:00:00Z", "supplier": "marleen.ketelaars", "source": "3Di", "model_identifier": null, "model_revision": "39433", "model_name": "ssw-medemblik-maatregelmodel-midwoud-2", "has_raw_results": true, "total_size": 232439314, "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/1681c138-ef1b-44fa-836f-b618f250a53d/?format=api", "uuid": "1681c138-ef1b-44fa-836f-b618f250a53d", "name": "Hauwert_Maatregelen_rev1_Bui08", "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-04-26T11:12:29.265850Z", "last_modified": "2022-07-20T08:20:06.858542Z", "simulation_identifier": "70810", "simulation_start": "2000-01-01T12:00:00Z", "simulation_end": "2000-01-01T16:00:00Z", "supplier": "marleen.ketelaars", "source": "3Di", "model_identifier": null, "model_revision": "39206", "model_name": "w0152_medemblik_hauwert_maatregelvariant-1", "has_raw_results": true, "total_size": 133160614, "spatial_bounds": { "west": 5.07340309480807, "east": 5.12582302319515, "north": 52.721047882821, "south": 52.685410525003 }, "projection": "EPSG:28992", "origin_x": 133798.0, "origin_y": 522043.5, "pixelsize_x": 0.5, "pixelsize_y": -0.5, "upper_bound_x": 137325.5, "upper_bound_y": 525995.0 }, { "url": "https://demo.lizard.net/api/v4/scenarios/eb771481-1288-4560-9835-dfaa84ce78c1/?format=api", "uuid": "eb771481-1288-4560-9835-dfaa84ce78c1", "name": "Andijk_Maatregelen_rev1_Bui08", "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-04-26T10:51:55.855591Z", "last_modified": "2022-07-20T08:10:31.256777Z", "simulation_identifier": "70802", "simulation_start": "2000-01-01T12:00:00Z", "simulation_end": "2000-01-01T16:00:00Z", "supplier": "marleen.ketelaars", "source": "3Di", "model_identifier": null, "model_revision": "39303", "model_name": "ssw-medemblik-maatregelmodel-andijk-1", "has_raw_results": true, "total_size": 452601668, "spatial_bounds": { "west": 5.17095772879867, "east": 5.25792209390588, "north": 52.7548935216066, "south": 52.7310201023463 }, "projection": "EPSG:28992", "origin_x": 140400.5, "origin_y": 527094.5, "pixelsize_x": 0.5, "pixelsize_y": -0.5, "upper_bound_x": 146267.0, "upper_bound_y": 529737.0 } ] }