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

{
    "count": 356,
    "next": "https://demo.lizard.net/api/v4/scenarios/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/788cd173-9520-4e5a-bc9c-e4fe924e25d4/",
            "uuid": "788cd173-9520-4e5a-bc9c-e4fe924e25d4",
            "name": "ilan2024_v10_op",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/74983d5a-0fd8-4c22-bb09-e7656d570fb6/",
                "uuid": "74983d5a-0fd8-4c22-bb09-e7656d570fb6",
                "name": "N&S Branch Office"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-06-21T11:13:34.324806Z",
            "last_modified": "2024-07-15T06:18:38.582120Z",
            "simulation_identifier": "203759",
            "simulation_start": "2024-07-15T05:00:00Z",
            "simulation_end": "2024-07-15T09:00:00Z",
            "supplier": "kuan-wei.chen",
            "source": "3Di",
            "model_identifier": "65131",
            "model_revision": "57600",
            "model_name": "ilan2024-10",
            "has_raw_results": true,
            "total_size": 2075901734,
            "spatial_bounds": {
                "west": 121.71999477390285,
                "east": 121.83973525972297,
                "north": 24.713177978775917,
                "south": 24.583939513477052
            },
            "projection": "EPSG:3826",
            "origin_x": 322920.0,
            "origin_y": 2719954.0,
            "pixelsize_x": 1.0,
            "pixelsize_y": 1.0,
            "upper_bound_x": 334961.0,
            "upper_bound_y": 2734201.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b/",
            "uuid": "db7cd681-24fd-4a8c-a98e-0bf6eb5bed7b",
            "name": "T3D-live-demo-rotterdam-origineel #1_2024-06-10T115929",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/42eec8b6-604c-49c5-9b9e-9fe821510314/",
                "uuid": "42eec8b6-604c-49c5-9b9e-9fe821510314",
                "name": "Virtual City Systems"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-06-10T11:42:41.320931Z",
            "last_modified": "2024-06-24T09:19:56.086559Z",
            "simulation_identifier": "196644",
            "simulation_start": "2024-06-10T09:59:29Z",
            "simulation_end": "2124-05-17T09:59:29Z",
            "supplier": null,
            "source": "3Di",
            "model_identifier": "64929",
            "model_revision": "44724",
            "model_name": "t3d-live-demo-rotterdam-origineel-1",
            "has_raw_results": true,
            "total_size": 132918296,
            "spatial_bounds": {
                "west": 4.454747612294874,
                "east": 4.4669925418717495,
                "north": 51.92841295323644,
                "south": 51.90829060661301
            },
            "projection": "EPSG:28992",
            "origin_x": 90865.3,
            "origin_y": 435943.50000000006,
            "pixelsize_x": 0.1,
            "pixelsize_y": 0.1,
            "upper_bound_x": 91679.40000000001,
            "upper_bound_y": 438172.10000000003
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/",
            "uuid": "78d58488-6b84-496b-aee0-f302c21cd95b",
            "name": "Mats Pullen 2 15-3-24",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/2bf14037-3e6a-413b-8407-0d40347080b0/",
                "uuid": "2bf14037-3e6a-413b-8407-0d40347080b0",
                "name": "Hogeschool Rotterdam"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-03-15T11:51:59.688151Z",
            "last_modified": "2024-03-15T11:54:49.210427Z",
            "simulation_identifier": "180247",
            "simulation_start": "2024-03-15T11:42:41Z",
            "simulation_end": "2124-02-20T11:42:41Z",
            "supplier": "hrstudent1",
            "source": "3Di",
            "model_identifier": "62441",
            "model_revision": "26246",
            "model_name": "schouwen-duiveland-2d-hr-schouwenduiveland_schouwenduiveland-1-0",
            "has_raw_results": true,
            "total_size": 541190888,
            "spatial_bounds": {
                "west": 3.655264525622011,
                "east": 4.120402343289105,
                "north": 51.765518958027435,
                "south": 51.59707727595284
            },
            "projection": "EPSG:28992",
            "origin_x": 35435.0,
            "origin_y": 402325.0,
            "pixelsize_x": 5.0,
            "pixelsize_y": 5.0,
            "upper_bound_x": 67240.0,
            "upper_bound_y": 420415.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/",
            "uuid": "f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde",
            "name": "Mats Pullen 15-3-24",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/2bf14037-3e6a-413b-8407-0d40347080b0/",
                "uuid": "2bf14037-3e6a-413b-8407-0d40347080b0",
                "name": "Hogeschool Rotterdam"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-03-15T09:49:37.548935Z",
            "last_modified": "2024-03-15T11:54:49.214061Z",
            "simulation_identifier": "180227",
            "simulation_start": "2024-03-15T09:29:05Z",
            "simulation_end": "2124-02-20T09:29:05Z",
            "supplier": "hrstudent1",
            "source": "3Di",
            "model_identifier": "62441",
            "model_revision": "26246",
            "model_name": "schouwen-duiveland-2d-hr-schouwenduiveland_schouwenduiveland-1-0",
            "has_raw_results": true,
            "total_size": 563187098,
            "spatial_bounds": {
                "west": 3.655264525622011,
                "east": 4.120402343289105,
                "north": 51.765518958027435,
                "south": 51.59707727595284
            },
            "projection": "EPSG:28992",
            "origin_x": 35435.0,
            "origin_y": 402325.0,
            "pixelsize_x": 5.0,
            "pixelsize_y": 5.0,
            "upper_bound_x": 67240.0,
            "upper_bound_y": 420415.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/",
            "uuid": "b8009661-9f11-4d1b-ba94-a835888e5abf",
            "name": "groep 8 ouwerkerk versie 10",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/2bf14037-3e6a-413b-8407-0d40347080b0/",
                "uuid": "2bf14037-3e6a-413b-8407-0d40347080b0",
                "name": "Hogeschool Rotterdam"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-03-12T14:20:26.738195Z",
            "last_modified": "2024-03-15T09:35:18.392773Z",
            "simulation_identifier": "179790",
            "simulation_start": "2024-03-12T13:41:55Z",
            "simulation_end": "2124-02-17T13:41:55Z",
            "supplier": "hrstudent1",
            "source": "3Di",
            "model_identifier": "62441",
            "model_revision": "26246",
            "model_name": "schouwen-duiveland-2d-hr-schouwenduiveland_schouwenduiveland-1-0",
            "has_raw_results": true,
            "total_size": 564877722,
            "spatial_bounds": {
                "west": 3.655264525622011,
                "east": 4.120402343289105,
                "north": 51.765518958027435,
                "south": 51.59707727595284
            },
            "projection": "EPSG:28992",
            "origin_x": 35435.0,
            "origin_y": 402325.0,
            "pixelsize_x": 5.0,
            "pixelsize_y": 5.0,
            "upper_bound_x": 67240.0,
            "upper_bound_y": 420415.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/",
            "uuid": "a4058100-14b5-42f2-8836-f281d9dec06f",
            "name": "Groep 8 Ouwerkerk Noodkeringen versie 9",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/2bf14037-3e6a-413b-8407-0d40347080b0/",
                "uuid": "2bf14037-3e6a-413b-8407-0d40347080b0",
                "name": "Hogeschool Rotterdam"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-03-12T13:40:01.252302Z",
            "last_modified": "2024-03-15T09:35:18.358464Z",
            "simulation_identifier": "179785",
            "simulation_start": "2024-03-12T13:18:19Z",
            "simulation_end": "2124-02-17T13:18:19Z",
            "supplier": "hrstudent1",
            "source": "3Di",
            "model_identifier": "62441",
            "model_revision": "26246",
            "model_name": "schouwen-duiveland-2d-hr-schouwenduiveland_schouwenduiveland-1-0",
            "has_raw_results": true,
            "total_size": 556216492,
            "spatial_bounds": {
                "west": 3.655264525622011,
                "east": 4.120402343289105,
                "north": 51.765518958027435,
                "south": 51.59707727595284
            },
            "projection": "EPSG:28992",
            "origin_x": 35435.0,
            "origin_y": 402325.0,
            "pixelsize_x": 5.0,
            "pixelsize_y": 5.0,
            "upper_bound_x": 67240.0,
            "upper_bound_y": 420415.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/",
            "uuid": "47e8e9df-5349-4b7c-97df-7fc10d22e271",
            "name": "Groep 8 Ouwerkerk noodkeringen versie 8",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/2bf14037-3e6a-413b-8407-0d40347080b0/",
                "uuid": "2bf14037-3e6a-413b-8407-0d40347080b0",
                "name": "Hogeschool Rotterdam"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-03-12T13:03:14.442615Z",
            "last_modified": "2024-03-15T09:35:18.371615Z",
            "simulation_identifier": "179775",
            "simulation_start": "2024-03-12T12:49:57Z",
            "simulation_end": "2124-02-17T12:49:57Z",
            "supplier": "hrstudent1",
            "source": "3Di",
            "model_identifier": "62441",
            "model_revision": "26246",
            "model_name": "schouwen-duiveland-2d-hr-schouwenduiveland_schouwenduiveland-1-0",
            "has_raw_results": true,
            "total_size": 566065589,
            "spatial_bounds": {
                "west": 3.655264525622011,
                "east": 4.120402343289105,
                "north": 51.765518958027435,
                "south": 51.59707727595284
            },
            "projection": "EPSG:28992",
            "origin_x": 35435.0,
            "origin_y": 402325.0,
            "pixelsize_x": 5.0,
            "pixelsize_y": 5.0,
            "upper_bound_x": 67240.0,
            "upper_bound_y": 420415.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/",
            "uuid": "91373aa6-f692-4f3b-bd69-a4d88dc5f26d",
            "name": "Mats Pullen 8-3-24",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/2bf14037-3e6a-413b-8407-0d40347080b0/",
                "uuid": "2bf14037-3e6a-413b-8407-0d40347080b0",
                "name": "Hogeschool Rotterdam"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-03-08T13:05:09.815201Z",
            "last_modified": "2024-03-15T11:54:49.235890Z",
            "simulation_identifier": "179346",
            "simulation_start": "2024-03-08T12:29:48Z",
            "simulation_end": "2124-02-13T12:29:48Z",
            "supplier": "hrstudent1",
            "source": "3Di",
            "model_identifier": "62441",
            "model_revision": "26246",
            "model_name": "schouwen-duiveland-2d-hr-schouwenduiveland_schouwenduiveland-1-0",
            "has_raw_results": true,
            "total_size": 592089930,
            "spatial_bounds": {
                "west": 3.655264525622011,
                "east": 4.120402343289105,
                "north": 51.765518958027435,
                "south": 51.59707727595284
            },
            "projection": "EPSG:28992",
            "origin_x": 35435.0,
            "origin_y": 402325.0,
            "pixelsize_x": 5.0,
            "pixelsize_y": 5.0,
            "upper_bound_x": 67240.0,
            "upper_bound_y": 420415.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/",
            "uuid": "eb1f4d68-688e-4dbd-a339-3dac67df1aa9",
            "name": "Mats Pullen Dijkdoorbraak Bruinisse 2024 8-3-24",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/2bf14037-3e6a-413b-8407-0d40347080b0/",
                "uuid": "2bf14037-3e6a-413b-8407-0d40347080b0",
                "name": "Hogeschool Rotterdam"
            },
            "project": "https://demo.lizard.net/api/v4/projects/7a4716ff-e1b8-4345-9338-ea7614364a6b/",
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-03-08T12:28:00.449814Z",
            "last_modified": "2024-03-15T11:54:49.225014Z",
            "simulation_identifier": "179341",
            "simulation_start": "2024-03-08T12:22:51Z",
            "simulation_end": "2124-02-13T12:22:51Z",
            "supplier": "hrstudent1",
            "source": "3Di",
            "model_identifier": "62441",
            "model_revision": "26246",
            "model_name": "schouwen-duiveland-2d-hr-schouwenduiveland_schouwenduiveland-1-0",
            "has_raw_results": true,
            "total_size": 567960591,
            "spatial_bounds": {
                "west": 3.655264525622011,
                "east": 4.120402343289105,
                "north": 51.765518958027435,
                "south": 51.59707727595284
            },
            "projection": "EPSG:28992",
            "origin_x": 35435.0,
            "origin_y": 402325.0,
            "pixelsize_x": 5.0,
            "pixelsize_y": 5.0,
            "upper_bound_x": 67240.0,
            "upper_bound_y": 420415.0
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/",
            "uuid": "d64991e3-ca59-4a93-916c-83d7e6f1d5c0",
            "name": "Burgh Haamstede Zonder maatregel",
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/2bf14037-3e6a-413b-8407-0d40347080b0/",
                "uuid": "2bf14037-3e6a-413b-8407-0d40347080b0",
                "name": "Hogeschool Rotterdam"
            },
            "project": null,
            "description": "",
            "extra_metadata": {},
            "access_modifier": "Public",
            "created": "2024-03-08T08:15:46.463275Z",
            "last_modified": "2024-03-15T09:35:24.599147Z",
            "simulation_identifier": "179269",
            "simulation_start": "2024-03-08T08:13:28Z",
            "simulation_end": "2124-02-13T08:13:28Z",
            "supplier": "hrstudent1",
            "source": "3Di",
            "model_identifier": "62441",
            "model_revision": "26246",
            "model_name": "schouwen-duiveland-2d-hr-schouwenduiveland_schouwenduiveland-1-0",
            "has_raw_results": true,
            "total_size": 564085285,
            "spatial_bounds": {
                "west": 3.655264525622011,
                "east": 4.120402343289105,
                "north": 51.765518958027435,
                "south": 51.59707727595284
            },
            "projection": "EPSG:28992",
            "origin_x": 35435.0,
            "origin_y": 402325.0,
            "pixelsize_x": 5.0,
            "pixelsize_y": 5.0,
            "upper_bound_x": 67240.0,
            "upper_bound_y": 420415.0
        }
    ]
}