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=13
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=14",
    "previous": "https://demo.lizard.net/api/v4/scenarios/?format=api&page=12",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e75c175-9fbf-49e7-aa47-a3329c026985/?format=api",
            "uuid": "5e75c175-9fbf-49e7-aa47-a3329c026985",
            "name": "Nibbixwoud_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-04-05T13:43:59.625063Z",
            "last_modified": "2022-07-20T08:29:31.866800Z",
            "simulation_identifier": "68660",
            "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": 538052732,
            "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/454fc7df-fa14-40c1-96cc-98ecf1342da1/?format=api",
            "uuid": "454fc7df-fa14-40c1-96cc-98ecf1342da1",
            "name": "Opperdoes_Maatregelen_rev1_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-03-30T10:37:51.936188Z",
            "last_modified": "2022-07-20T08:31:30.473683Z",
            "simulation_identifier": "66359",
            "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": 330273387,
            "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/1580d2f0-ed19-4485-a6ab-9bae900a124c/?format=api",
            "uuid": "1580d2f0-ed19-4485-a6ab-9bae900a124c",
            "name": "Andijk_Maatregelen_rev1_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-03-28T16:17:19.073683Z",
            "last_modified": "2022-07-20T08:14:52.169113Z",
            "simulation_identifier": "65890",
            "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": 460514787,
            "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/8b8c18a7-0722-42f2-9993-8d1a43ba3082/?format=api",
            "uuid": "8b8c18a7-0722-42f2-9993-8d1a43ba3082",
            "name": "mb_hauwert_maatr_rev1_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-03-23T09:10:17.056314Z",
            "last_modified": "2022-07-20T08:21:12.695358Z",
            "simulation_identifier": "65349",
            "simulation_start": "2000-01-01T07:00:00Z",
            "simulation_end": "2000-01-01T11: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": 134307766,
            "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/94b50294-3a0f-4d0b-a642-f8ca4b029b44/?format=api",
            "uuid": "94b50294-3a0f-4d0b-a642-f8ca4b029b44",
            "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-16T08:04:48.808284Z",
            "last_modified": "2022-02-17T08:07:29.049401Z",
            "simulation_identifier": "61005",
            "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": 298610844,
            "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/ed021cbe-e84f-44b8-aefc-9ab99bbeeeb0/?format=api",
            "uuid": "ed021cbe-e84f-44b8-aefc-9ab99bbeeeb0",
            "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-16T08:04:19.696151Z",
            "last_modified": "2022-02-17T08:30:45.926594Z",
            "simulation_identifier": "61003",
            "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": 298616077,
            "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/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/?format=api",
            "uuid": "dfb1b3ad-942e-4e6e-977c-ab2977a4901d",
            "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-16T08:03:27.453724Z",
            "last_modified": "2022-02-17T08:07:53.064974Z",
            "simulation_identifier": "61006",
            "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": 298602184,
            "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/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/?format=api",
            "uuid": "57d0ece2-d452-4b52-ae6f-cdaaefb395c6",
            "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-16T08:02:41.852026Z",
            "last_modified": "2022-02-17T08:30:50.944534Z",
            "simulation_identifier": "61004",
            "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": 298605137,
            "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/6046aeeb-aa6c-40ba-8cea-7e077bb3466e/?format=api",
            "uuid": "6046aeeb-aa6c-40ba-8cea-7e077bb3466e",
            "name": "Eygelshoven - Maatregel D rev 1 Radar",
            "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-15T23:46:08.806430Z",
            "last_modified": "2022-02-17T08:08:40.874856Z",
            "simulation_identifier": "60946",
            "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": 301579826,
            "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/3322ce16-2683-4266-ae10-a14a7d9dce58/?format=api",
            "uuid": "3322ce16-2683-4266-ae10-a14a7d9dce58",
            "name": "Eygelshoven - Maatregel E rev 1 Radar",
            "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-15T23:45:31.761472Z",
            "last_modified": "2022-02-17T08:09:03.997166Z",
            "simulation_identifier": "60947",
            "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": 284773497,
            "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
        }
    ]
}