Skip to content

Editor

The Editor module enables network-level modifications to existing scenarios. It allows users to apply targeted structural changes to the simulation network — for example, to simulate roadworks, incidents, traffic control measures, or policy interventions.

Through the editor/scenario/<id> endpoint, users can modify selected elements of the scenario network without needing to rebuild it from scratch. The system supports a variety of patch types, including:

  • Closing edges (e.g. road closures)
  • Removing lanes (e.g. temporary capacity reduction)
  • Adjusting speed limits
  • Changing allowed vehicle classes (vClass restrictions)
  • Modifying lane to lane connections at intersections

Endpoint: editor/scenario/<id>

GET

The GET editor/scenario/<id> request returns the current state of the scenario network as a detailed GeoJSON structure, including edges, lanes and junction shapes. This file reflects the scenario after any previous edits have been applied. It allows clients (e.g., frontend editors or automated tools) to retrieve the full network geometry and metadata to enable interactive editing, validation, or visualization of the scenario.

The returned GeoJSON structure includes:

  • Edge geometries and attributes (e.g., speed, allowed vehicle classes, fromNode, toNode)
  • Lane geometries, connections (outgoing lanes), and lane-specific metadata
  • Junction geometries

GET: Authorization

This endpoint requires authentication. The authenticated user (or session, in case of guest access) must be the owner of the scenario. Otherwise, a HTTP 404 response is returned.

GET: Response

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": {
        "coordinates": [
          [
            [ 13.334833, 52.503476 ],
            ...
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "allow":  [ "bicycle", "bus", "passenger" ],
        "element": "edge",
        "id": "-111812579#1",
        "name": "Rankestraße",
        "numLanes": 1,
        "fromNode": "121",
        "toNode": "5622"
      },
      "type": "Feature"
    },
    ...
    {
      "geometry": {
        "coordinates": [
          [
            [ 13.33999, 52.503991 ],
            ...
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "allow": [ "pedestrian" ],
        "element": "lane",
        "id": "109#2_0",
        "index": 0,
        "maxSpeed": 2.78,
        "outgoingLanes": [ "-122#3_0", "123#2_0", "544#5_1" ],
        "directions": [ "r", "l", "s" ]
      },
      "type": "Feature"
    },
    ...
    {
      "geometry": {
        "coordinates": [
          [
            [ 13.334833, 52.503476 ],
            ...
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "element": "junction",
        "id": "7845"
      },
      "type": "Feature"
    },
    ...
  ]
}

PATCH

The PATCH editor/scenario/<id> request allows users to apply targeted modifications to the scenario network by submitting only the features that should be changed. The request body must contain a valid GeoJSON structure that includes the modified features (i.e., edges or lanes that should be updated).

Each feature in the GeoJSON payload triggers a corresponding patch operation for the SUMO simulation network. Depending on the element type (edge or lane), different types of updates may be applied — such as changing allowed vehicle classes, adjusting speed limits, disabling lanes, or altering connection behavior.

The modification is performed asynchronously: upon receiving the request, the API schedules a background task that applies the patch to the scenario. The response includes a unique task ID (result_id) and a status_url that can be used to track the progress of the operation.

PATCH: Authorization

Only users who own the scenario (or sessions in the case of guest access) are allowed to modify it. If the scenario is not accessible or does not exist, a 404 response is returned.

PATCH: Request

Changing Edge Properties

The following JSON structure shows an example of a PATCH request that updates several edge properties. This method currently only allows modifying the number of lanes (numLanes) for the specified edge(s):

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": { ... },
      "properties": {
        "element": "edge",
        "id": "123#4",
        "numLanes": 5
      },
      "type": "Feature"
    },
    ...
  ]
}

This results in the following patch being applied to the SUMO scenario network:

XML
1
2
3
4
<edges>
  <edge id="123#4" numLanes="5"/>
  ...
</edges>
Changing Lane Properties

The following JSON structure shows an example of a PATCH request that updates lane properties.

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": { ... },
      "properties": {
        "allow": ["bicycle", "bus", "passenger" ],
        "element": "lane",
        "id": "123#4_2",
        "maxSpeed": 8.33,
      },
      "type": "Feature"
    },
    ...
  ]
}

This results in the following patch being applied to the SUMO scenario network:

XML
1
2
3
4
5
6
<edges>
  <edge id="123#4">
    <lane index="2" allow="bicycle bus passenger" speed="8.33" />
  </edge>
  ...
</edges>

Please note, that edge and lane changes are merged in the patch if possible.

Deleting Edges or Lanes

The following JSON structure shows an example of a PATCH request that deletes an edge. The action property specifies the intended operation to be performed on the feature. Setting action to delete will permanently remove the edge or lane from the scenario network.

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": { ... },
      "properties": {
        "element": "edge",
        "id": "123#4",
        "action": "delete" // ← action specifies to delete the edge
      },
      "type": "Feature"
    },
    {
      "geometry": { ... },
      "properties": {
        "element": "lane",
        "id": "456#7_2",
        "action": "delete" // ← action specifies to delete the lane
      },
      "type": "Feature"
    },
    ...
  ]
}

If "action" : "delete" is provided, all other properties are ignored. This results in the following patch being applied to the SUMO scenario network:

XML
1
2
3
4
5
<edges>
   <delete id="123#4"/>
   <delete id="456#7" index="2"/>
  ...
</edges>
Closing Edges or Lanes

The following JSON structure shows an example of a PATCH request that closes an edge and a lane on another edge. Setting action to close will store the currently allowed vehicle classes and then disallow any vehicle on that edge or lane.

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": { ... },
      "properties": {
        "element": "edge",
        "id": "123#4",
        "action": "close",             // ← specifies to close an edge
        "allow": ["bus", "passenger"], // ← access permissions before closing
        "maxSpeed": 8.33,
      },
      "type": "Feature"
    },
    {
      "geometry": { ... },
      "properties": {
        "element": "lane",
        "id": "456#7_2",
        "action": "close",           // ← specifies to close a lane
        "allow": ["bicycle", "bus"], // ← access permissions before closing
        "maxSpeed": 8.33,
      },
      "type": "Feature"
    },
    ...
  ]
}

If allow is present in the properties of the feature in the request, but it is empty, then it is assumed, that the edge (or lane) has no access restrictions. Thus allow="all" will be saved as original access properties.

If allow is not present in the properties of the feature in the request, then it is assumed, that the access restrictions of the edge (or lane) should be retrieved from the current network and stored for the re-opening.

Other properties, e.g. speed or name will be merged in the patch.

This results in the following patch being applied to the SUMO scenario network:

XML
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
<edges>
  <edge id="123#4" disallow="all" speed="8.33">
    <param key="SESAM_ALLOW_BEFORE_CLOSING" value="bus passenger"/>
  </edge>
  <edge id="456#7">
    <lane index="2" disallow="all" speed="8.33">
      <param key="SESAM_ALLOW_BEFORE_CLOSING" value="bicycle bus"/>
    </lane>
  </edge>
  ...
</edges>
Opening Edges or Lanes

The following JSON structure shows an example of a PATCH request that opens an edge and a lane on another edge. Setting action to open will restore the allowed vehicle classes on that edge or lane.

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": { ... },
      "properties": {
        "element": "edge",
        "id": "123#4",
        "action": "open",              // ← open the edge (optional)
        "allow": ["bus", "passenger"], // ← new access permissions
        "maxSpeed": 8.33,
      },
      "type": "Feature"
    },
    {
      "geometry": { ... },
      "properties": {
        "element": "lane",
        "id": "456#7_2",
        "action": "open",         // ← open the lane
        "allow": [],              // ← restore previous allow values
        "maxSpeed": 8.33,
      },
      "type": "Feature"
    },
    ...
  ]
}

If allow is present in the properties of the feature in the request and it is not empty, then these values are taken as the new restrictions for that lane or edge. In this case, the "action": "open" is optional (see edge 123#4 in the example above). The patch will override the allowed vehicle classes for that edge.

If allow is not present (or it is present and empty), then it is assumed, that the access restrictions of the edge (or lane) should be restored from previous values in the network. If there are no previous values to be restored in the network, the edge (or lane) will be opened by default for all vehicle classes.

Other properties, e.g. speed or name will be merged in the patch.

This results in the following patch being applied to the SUMO scenario network:

XML
1
2
3
4
5
6
7
8
<edges>
  <edge id="123#4" allow="bus passenger" speed="8.33"/>
  <edge id="456#7">
    <!-- previous values will be restored -->
    <lane index="2" allow="..." speed="8.33"/> 
  </edge>
  ...
</edges>
Modifying Connections

Connections can be modified by changing properties of lanes only, i.e., features with the type lane. It is similar to modifying basic lane properties. The following JSON structure shows an example of a PATCH request that updates the lane to lane connections.

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": { ... },
      "properties": {
        "element": "lane",
        "id": "123#4_2",
        "outgoingLanes": ["-122_1", "212_0", "246_4"]
      },
      "type": "Feature"
    },
    ...
  ]
}

This results in the following connections patch being applied to the SUMO scenario network:

XML
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<connections>
  <!-- delete all previous connections for 123#4_2 -->
  <delete from="123#4" fromLane="2" ... /> 

  <!-- create new connections for 123#4_2 -->
  <connection from="123#4" fromLane="2" to="-122" toLane="1"/>
  <connection from="123#4" fromLane="2" to="212" toLane="0"/>
  <connection from="123#4" fromLane="2" to="246" toLane="4"/>
  ...
</connections>

PATCH: Response

If the patch request is accepted, the API returns a JSON response containing a unique task ID and a status URL:

JSON
1
2
3
4
{
  "result_id": "<uuid>",
  "status_url": "http://<server-url>/api/v1/editor/scenario-status/<uuid>"
}