EditRequest

simulation_idintegerrequired

The id of the simulation which is the scope of the edit action.

dry_runboolean

If true then the result message will be as usual but the changes won’t be committed to the database.

Default value: false

notify_assignmentboolean

If true and action involves node assignment or unassignment then for each assigned and node ASSIGNMENT message is sent and NodeLog object is added. Default depends on settings.MANUAL_EDIT_NOTIFY_ASSIGNMENT

action objectrequired

The concrete action to perform. The specific fields depend on the 'action_type'.

action_typerequired

The concrete action to perform. The specific fields depend on the 'action_type'.

Possible values: [vehicle_reorder_nodes, vehicle_assign_booking, vehicle_unassign_bookings, vehicle_complex_rearrange, invalidate_bookings, invalidate_vehicles, delete_vehicles, vehicle_assign_booking_list, vehicle_shift_nodes]

vehicle_reorder_nodes

agent_idstring<uuid>required

Vehicle agent_id.

node_uid_new_sequencestring<uuid>[]required

List of UIDs of nodes which define the new route of a vehicle

strict_time_windowsboolean

Enable or disable strict checking of time window constraints.

Default value: true

node_grouping_thresholdinteger

Non-negative value defines time interval in seconds which will be used to group upcoming nodes. Negative then grouping is disabled.

Default value: -1

vehicle_assign_booking

agent_idstring<uuid>required

Vehicle agent_id.

booking_uidstring<uuid>required

The UID of the booking being assigned.

strict_capacityboolean

Enable or disable strict checking of capacity constraint.

Default value: false

strict_time_windowsboolean

Enable or disable strict checking of time windows constraints.

Default value: true

pickup_positioninteger

Optional 0-based index of the desired pickup location in the new route. The position will be optimized otherwise.

Possible values: >= 0

dropoff_positioninteger

Optional 0-based index of the desired dropoff location in the new route. The position will be optimized otherwise.

Possible values: >= 0

vehicle_unassign_bookings

agent_idsstring<uuid>[]

Unassign all bookings from each specified vehicle.

Default value: []

booking_uidsstring<uuid>[]

List of bookings uids to unassign.

Default value: []

node_grouping_thresholdinteger

Non-negative value defines time interval in seconds which will be used to group upcoming nodes. Negative then grouping is disabled.

Default value: -1

partial_successboolean

If set to true and certain bookings can not be unassigned, e.g. because they contain upcoming nodes, have wrong status, etc then these bookings are skipped and other bookings are inserted. The UIDs of the failed bookings and nodes will be reported in details["rejected_bookings"] and details["rejected_nodes"] of the response object.

Default value: false

vehicle_complex_rearrange

vehicle_route_mapobjectrequired

A dictionary containing vehicles' new routes. The key is vehicle's agent_id (UUID string), the value describes the route.

strict_time_windowsboolean

Enable or disable strict checking of time windows constraints.

Default value: true

invalidate_bookings

booking_uidsstring<uuid>[]required

List of uids of the bookings to be invalidated.

invalidate_vehicles

agent_idsstring<uuid>[]required

List of uids of the vehicles to be invalidated.

remove_point_nodesboolean

If true then assigned point nodes will be removed.

Default value: true

delete_vehicles

agent_idsstring<uuid>[]required

List of uids of the vehicles to be deleted.

vehicle_assign_booking_list

agent_idstring<uuid>required

Vehicle agent_id.

booking_uidsstring<uuid>[]required

The list of UIDs of the bookings being assigned.

strict_capacityboolean

Enable or disable strict checking of capacity constraint.

Default value: false

strict_time_windowsboolean

Enable or disable strict checking of time windows constraints.

Default value: true

pickup_insert_beforeinteger

Optional 0-based index of a node before which all unassigned pickups will be assigned, otherwise optimized

Possible values: >= 0

pickup_insert_before_uidstring<uuid>

Optional UID of a node before which to insert all pickups. Conflicts with pickup_insert_before.

dropoff_insert_afterinteger

Optional 0-based index of a node after which all unassigned dropoffs will be assigned, otherwise optimized

Possible values: >= 0

dropoff_insert_after_uidstring<uuid>

Optional UID of a node after which to insert all dropoffs. Conflicts with dropoff_insert_after.

node_grouping_thresholdinteger

Non-negative value defines time interval in seconds which will be used to group upcoming nodes. Negative then grouping is disabled.

Default value: -1

partial_successboolean

If true, skip bookings that cannot be inserted and report them in the details.

Default value: false

vehicle_shift_nodes

vehicles objectrequired

A dictionary containing agent_id as a key and shift context object as a value. Multiple vehicles can be specified.

property name* object

new_scheduled_timestampstring<date-time>required

New timestamp of the heading node.

start_from_node_uidstring,null<uuid>nullable

Use this node as a heading node. If not specified or null, then first assigned node is used.

Default value: null

partial_successboolean

If set to true and certain vehicles can not be processed then they are skipped. The UIDs of the failed vehicles will be reported in details["rejected_vehicles"].

Default value: false

EditRequest

{
  "simulation_id": 0,
  "dry_run": false,
  "notify_assignment": true,
  "action": {
    "action_type": "string",
    "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "node_uid_new_sequence": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "strict_time_windows": true,
    "node_grouping_threshold": -1
  }
}