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=14
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=15",
    "previous": "https://demo.lizard.net/api/v4/scenarios/?format=api&page=13",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/?format=api",
            "uuid": "9843da10-6e95-43d9-b2b5-99d2cd5615c7",
            "name": "Eygelshoven - Maatregel B 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:42:22.523497Z",
            "last_modified": "2022-02-17T08:07:58.255680Z",
            "simulation_identifier": "60944",
            "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": 301566173,
            "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/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/?format=api",
            "uuid": "b7b9155e-5df1-4c47-aa6a-f51a54bbfc81",
            "name": "Eygelshoven - Maatregel C 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:29:35.130877Z",
            "last_modified": "2022-02-17T08:08:23.823408Z",
            "simulation_identifier": "60945",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38414",
            "model_name": "eygelshoven-maatregel-c-1",
            "has_raw_results": true,
            "total_size": 301577820,
            "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/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/?format=api",
            "uuid": "eb57a6c8-4c02-4ae3-b64c-247200f63d7c",
            "name": "Eygelshoven - Maatregel A 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:28:23.072694Z",
            "last_modified": "2022-02-17T08:07:24.148137Z",
            "simulation_identifier": "60943",
            "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": 301565127,
            "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/761a0c61-422a-48a1-b255-a57f86193a3d/?format=api",
            "uuid": "761a0c61-422a-48a1-b255-a57f86193a3d",
            "name": "Eygelshoven - Huidig-verbeterd rev 2 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:21:01.255311Z",
            "last_modified": "2022-02-17T08:31:02.405283Z",
            "simulation_identifier": "60941",
            "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": 301602331,
            "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/3eff5477-2e19-49a0-9a8d-402a2b5821e3/?format=api",
            "uuid": "3eff5477-2e19-49a0-9a8d-402a2b5821e3",
            "name": "Eygelshoven - Verwacht rev 2 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:18:19.503347Z",
            "last_modified": "2022-02-17T08:06:41.629026Z",
            "simulation_identifier": "60942",
            "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": 301577090,
            "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/773499fa-69c4-4687-b166-c0c4ed2e6c27/?format=api",
            "uuid": "773499fa-69c4-4687-b166-c0c4ed2e6c27",
            "name": "Eygelshoven - Maatregel F 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:17:32.960768Z",
            "last_modified": "2022-02-17T08:09:26.973661Z",
            "simulation_identifier": "60948",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38417",
            "model_name": "eygelshoven-maatregel-f-1",
            "has_raw_results": true,
            "total_size": 301577109,
            "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/5731c1ab-7577-4f33-8474-2b96f2f821fa/?format=api",
            "uuid": "5731c1ab-7577-4f33-8474-2b96f2f821fa",
            "name": "Eygelshoven - Maatregel F 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-15T23:01:27.894342Z",
            "last_modified": "2022-02-17T08:09:14.090857Z",
            "simulation_identifier": "60940",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38417",
            "model_name": "eygelshoven-maatregel-f-1",
            "has_raw_results": true,
            "total_size": 298597950,
            "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/7c734008-4109-43b3-865d-67e7882499b4/?format=api",
            "uuid": "7c734008-4109-43b3-865d-67e7882499b4",
            "name": "Eygelshoven - Maatregel E 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-15T22:59:59.568389Z",
            "last_modified": "2022-02-17T08:08:59.865141Z",
            "simulation_identifier": "60939",
            "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": 275922672,
            "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/f7791ba4-9acf-4bc9-aef3-516343150df7/?format=api",
            "uuid": "f7791ba4-9acf-4bc9-aef3-516343150df7",
            "name": "Eygelshoven - Maatregel C 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-15T22:48:59.479002Z",
            "last_modified": "2022-02-17T08:08:20.090681Z",
            "simulation_identifier": "60936",
            "simulation_start": "2021-06-29T15:00:00Z",
            "simulation_end": "2021-06-29T18:00:00Z",
            "supplier": "leendert.vanwolfswin",
            "source": "3Di",
            "model_identifier": null,
            "model_revision": "38414",
            "model_name": "eygelshoven-maatregel-c-1",
            "has_raw_results": true,
            "total_size": 298611919,
            "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/feb3923f-4337-498e-9a6f-deb7a09d431d/?format=api",
            "uuid": "feb3923f-4337-498e-9a6f-deb7a09d431d",
            "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-15T22:48:30.372358Z",
            "last_modified": "2022-02-17T08:30:37.789623Z",
            "simulation_identifier": "60935",
            "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": 298602187,
            "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
        }
    ]
}