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=12
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=13",
    "previous": "https://demo.lizard.net/api/v4/scenarios/?format=api&page=11",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6e589998-c718-48bd-ac2f-a24f53f1e78a/?format=api",
            "uuid": "6e589998-c718-48bd-ac2f-a24f53f1e78a",
            "name": "Nibbixwoud_Maatregelen_rev2_60mm",
            "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:47:38.266015Z",
            "last_modified": "2022-07-20T08:30:09.168746Z",
            "simulation_identifier": "70790",
            "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": 554326155,
            "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/08d4640c-ab36-4fbe-82a9-6ffdcb96883b/?format=api",
            "uuid": "08d4640c-ab36-4fbe-82a9-6ffdcb96883b",
            "name": "Benningbroek_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-26T10:40:56.721618Z",
            "last_modified": "2022-07-20T08:17:16.191736Z",
            "simulation_identifier": "70804",
            "simulation_start": "2000-01-01T12:00:00Z",
            "simulation_end": "2000-01-01T16:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "39440",
            "model_name": "ssw-medemblik-maatregelmodel-benningbroek-3",
            "has_raw_results": true,
            "total_size": 473014266,
            "spatial_bounds": {
                "west": 4.97335806810181,
                "east": 5.05642755887396,
                "north": 52.7517534744901,
                "south": 52.6910778893102
            },
            "projection": "EPSG:28992",
            "origin_x": 127058.0,
            "origin_y": 522708.0,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 132636.0,
            "upper_bound_y": 529431.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d56cdd86-131c-4e87-99ea-fb26f55aad58/?format=api",
            "uuid": "d56cdd86-131c-4e87-99ea-fb26f55aad58",
            "name": "Opperdoes_Maatregelen_rev1_60mm",
            "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:38:48.628781Z",
            "last_modified": "2022-07-20T08:32:03.942420Z",
            "simulation_identifier": "70799",
            "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": 343907559,
            "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/7f98f383-b105-4460-a04c-b95c643bc03a/?format=api",
            "uuid": "7f98f383-b105-4460-a04c-b95c643bc03a",
            "name": "Wervershoof_Maatregelen_rev2_60mm",
            "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:38:43.456261Z",
            "last_modified": "2022-07-20T08:34:33.439622Z",
            "simulation_identifier": "70796",
            "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": 219689105,
            "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/72892450-4e6c-42aa-85dd-9c1911924589/?format=api",
            "uuid": "72892450-4e6c-42aa-85dd-9c1911924589",
            "name": "Andijk_Maatregelen_rev1_60mm",
            "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:36:38.541164Z",
            "last_modified": "2022-07-20T08:15:40.077090Z",
            "simulation_identifier": "70780",
            "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": 470531686,
            "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
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/da07d87e-6d92-46b0-927b-8c27c0447e29/?format=api",
            "uuid": "da07d87e-6d92-46b0-927b-8c27c0447e29",
            "name": "Medemblik_Maatregelen_rev3_60mm",
            "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:29:42.316282Z",
            "last_modified": "2022-07-20T09:09:58.668712Z",
            "simulation_identifier": "70793",
            "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": 187616460,
            "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/fa380eaa-3771-4220-8a8c-433228247fc0/?format=api",
            "uuid": "fa380eaa-3771-4220-8a8c-433228247fc0",
            "name": "Benningbroek_Maatregelen_rev3_60mm",
            "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:25:22.549735Z",
            "last_modified": "2022-07-20T08:18:55.112566Z",
            "simulation_identifier": "70782",
            "simulation_start": "2000-01-01T12:00:00Z",
            "simulation_end": "2000-01-01T16:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "39440",
            "model_name": "ssw-medemblik-maatregelmodel-benningbroek-3",
            "has_raw_results": true,
            "total_size": 490515945,
            "spatial_bounds": {
                "west": 4.97335806810181,
                "east": 5.05642755887396,
                "north": 52.7517534744901,
                "south": 52.6910778893102
            },
            "projection": "EPSG:28992",
            "origin_x": 127058.0,
            "origin_y": 522708.0,
            "pixelsize_x": 0.5,
            "pixelsize_y": -0.5,
            "upper_bound_x": 132636.0,
            "upper_bound_y": 529431.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eeb3aff-5d8d-47cf-bf15-633b04ddc456/?format=api",
            "uuid": "3eeb3aff-5d8d-47cf-bf15-633b04ddc456",
            "name": "Midwoud_Maatregelen_rev2_60mm",
            "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:24:06.077732Z",
            "last_modified": "2022-06-10T12:59:03.936281Z",
            "simulation_identifier": "70788",
            "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": 242062864,
            "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/2dfa406a-7757-403c-a185-0bdc0427f442/?format=api",
            "uuid": "2dfa406a-7757-403c-a185-0bdc0427f442",
            "name": "Hauwert_Maatregelen_rev1_60mm",
            "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:20:17.744537Z",
            "last_modified": "2022-07-20T08:21:48.411928Z",
            "simulation_identifier": "70786",
            "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": 41630049,
            "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/251bf9d4-9bb0-42a8-a683-483da45c7f10/?format=api",
            "uuid": "251bf9d4-9bb0-42a8-a683-483da45c7f10",
            "name": "Wervershoof_Referentie_rev11_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-04-26T10:19:28.171755Z",
            "last_modified": "2022-07-12T10:12:12.933187Z",
            "simulation_identifier": "70784",
            "simulation_start": "2000-01-01T12:00:00Z",
            "simulation_end": "2000-01-01T16:00:00Z",
            "supplier": "marleen.ketelaars",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "39655",
            "model_name": "medemblik_wevershoof-wervershoof_default-1-11",
            "has_raw_results": true,
            "total_size": 214033501,
            "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
        }
    ]
}