VRt.Studio [ST] (6.20.2289)

Veeroute Support Team: servicedesk@veeroute.comLicense: Proprietary Terms of Service

Veeroute Studio API.

Main site

Description

Server part of the Veeroute Studio.

Entity relationship diagram

erd

Explorer

Folders management.

Create folder

Create new folder.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Folder create request.

parent_key required	string<uuid> (unique_key) Key of the folder in which the new folder will be created.
name required	string [ 1 .. 100 ] characters New folder name.

Responses

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1_new"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Getting a filesystem

Getting a filesystem.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
type required	string (folder_type) Enum: "ROOT" "FOLDER" Element type: `ROOT` - root object `FOLDER` - folder
name required	string [ 1 .. 100 ] characters Folder name.
required	object (folder_stats) Current folder statistics.
elements	Array of objects (filesystem) [ 0 .. 101 ] items A list of child's elements.

Response samples

Content type

application/json

{"key": "5fffc47c-8239-42c4-8a3f-95d0ed235173",
"type": "ROOT",
"name": "ROOT",
"statistics": {"folders_count": 1,
"experiments_count": 3
},
"elements": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"type": "FOLDER",
"name": "MyFolder",
"statistics": {"folders_count": 0,
"experiments_count": 3
},
"elements": [ ]
}
]
}

Experiment list

Getting a experiments list.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

query Parameters

filter

string [ 1 .. 64 ] characters

Example: filter=example text

Filter for searching by text fields - only those experiments are returned whose name or description contains a substring from the filter.

Responses

Response Schema: application/json

required	Array of objects (experiment) [ 0 .. 101 ] items A list of experiments.
required	object (table_list_stats) Statistics by list.

Response samples

Content type

application/json

{"experiments": [{"key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
"specification": {"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "PT2H",
"waiting_time": "PT2H",
"break_time": "PT2H",
"working_time": "PT2H",
"arriving_time": "PT2H",
"departure_time": "PT2H",
"total_time": "PT2H",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"external_routing": false
},
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
}
},
"progress": 52,
"calculation": {"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "PT2H",
"business_validation_time": "PT2H",
"math_validation_time": "PT2H",
"waiting_time": "PT2H",
"calculation_time": "PT2H"
},
"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "STUDIO",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [ ],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-02-21T19:45:00Z",
"creation_date": "2024-02-21T19:45:00Z"
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Update folder

Rename \ move folder.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Request Body schema: application/json
required

Folder update request.

parent_key required	string<uuid> (unique_key) Key of the folder in which the new folder will be created.
name required	string [ 1 .. 100 ] characters New folder name.

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
type required	string (folder_type) Enum: "ROOT" "FOLDER" Element type: `ROOT` - root object `FOLDER` - folder
name required	string [ 1 .. 100 ] characters Folder name.
required	object (folder_stats) Current folder statistics.
elements	Array of objects (filesystem) [ 0 .. 101 ] items A list of child's elements.

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1_new"
}

Response samples

Content type

application/json

{"key": "5fffc47c-8239-42c4-8a3f-95d0ed235173",
"type": "ROOT",
"name": "ROOT",
"statistics": {"folders_count": 1,
"experiments_count": 3
},
"elements": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"type": "FOLDER",
"name": "MyFolder",
"statistics": {"folders_count": 0,
"experiments_count": 3
},
"elements": [ ]
}
]
}

Folder removal

Folder removal by key.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Experiment search

Experiment global search.

Authorizations:

ApiKeyAuth

query Parameters

filter	string [ 1 .. 64 ] characters Example: filter=example text Filter for searching by text fields - only those experiments are returned whose name or description contains a substring from the filter.
offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

required	Array of objects (experiment) [ 0 .. 101 ] items A list of experiments.
required	object (table_list_stats) Statistics by list.

Response samples

Content type

application/json

{"experiments": [{"key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
"specification": {"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "PT2H",
"waiting_time": "PT2H",
"break_time": "PT2H",
"working_time": "PT2H",
"arriving_time": "PT2H",
"departure_time": "PT2H",
"total_time": "PT2H",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"external_routing": false
},
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
}
},
"progress": 52,
"calculation": {"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "PT2H",
"business_validation_time": "PT2H",
"math_validation_time": "PT2H",
"waiting_time": "PT2H",
"calculation_time": "PT2H"
},
"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "STUDIO",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [ ],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-02-21T19:45:00Z",
"creation_date": "2024-02-21T19:45:00Z"
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Experiments

Experiments management.

Create experiment

Create new experiment.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Experiment create request.

name required	string [ 1 .. 100 ] characters Experiment name.
comment required	string or null [ 0 .. 10000 ] characters Default: null Experiment comment.
folder_key required	string<uuid> (unique_key) Parent folder key.

Responses

Request samples

Payload

Content type

application/json

{"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Reading experiment

Getting experiment information by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
"specification": {"name": "new experiment 1000",
"comment": "",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "default",
"trip_start_time_strategy": "EARLIEST_FINISH",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"replan_settings": {"replan_strategy": {"reorder": false,
"plan_new_orders": false,
"create_new_trips": false
},
"trips_settings": {"configuration": "default",
"trip_start_time_strategy": "EARLIEST_FINISH",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"actualize_settings": {"geo_settings": {"geo_provider": "OSRM",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"total_statistics_max_transport_load_capacity_a",
"total_statistics_max_transport_load_capacity_b",
"total_statistics_max_transport_load_capacity_c",
"total_statistics_max_transport_load_mass",
"total_statistics_max_transport_load_volume",
"total_statistics_cargo_capacity_ratio_capacity_a",
"total_statistics_cargo_capacity_ratio_capacity_b",
"total_statistics_cargo_capacity_ratio_capacity_c",
"total_statistics_cargo_capacity_ratio_mass",
"total_statistics_cargo_capacity_ratio_volume",
"total_statistics_cost",
"total_statistics_measurements_arriving_time",
"total_statistics_measurements_departure_time",
"total_statistics_measurements_distance",
"total_statistics_measurements_driving_time",
"total_statistics_measurements_time_window_from",
"total_statistics_measurements_time_window_to",
"total_statistics_measurements_total_time",
"total_statistics_measurements_waiting_time",
"total_statistics_measurements_working_time",
"total_statistics_orders_count",
"total_statistics_performers_count",
"total_statistics_plan_orders_count",
"total_statistics_quality_hard_time_window_violations_after_count",
"total_statistics_quality_hard_time_window_violations_before_count",
"total_statistics_quality_soft_time_window_violations_after_count",
"total_statistics_quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-02-15T13:56:07.697Z",
"to": "2024-02-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-02-15T13:56:07.728Z",
"creation_date": "2024-02-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

Experiment update

Rename \ move experiment.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Experiment specification update request.

name required	string [ 1 .. 100 ] characters Experiment name.
comment required	string or null [ 0 .. 10000 ] characters Default: null Experiment comment.
folder_key required	string<uuid> (unique_key) Parent folder key.

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"external_routing": false
},
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
}
},
"progress": 52,
"calculation": {"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
},
"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [{"type": "INCONSISTENT_REFERENCE",
"info": "entity error",
"entities": [{"entity_key": "order_0001",
"entity_type": "ORDER",
"child_entity": { }
}
]
}
],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-02-21T19:45:00Z",
"creation_date": "2024-02-21T19:45:00Z"
}

Experiment removal

Experiment removal by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Experiment duplicate

Experiment duplicate.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Experiment duplicate request.

name required	string [ 1 .. 100 ] characters Experiment name.
comment required	string or null [ 0 .. 10000 ] characters Default: null Experiment comment.
folder_key required	string<uuid> (unique_key) Parent folder key.

Responses

Request samples

Payload

Content type

application/json

{"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Settings update

Settings update.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Experiment settings update request.

required	object (plan_settings) Planning settings.
required	object (replan_settings) Replanning settings.
required	object (actualize_settings) Actualize settings.

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
}

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"external_routing": false
},
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
}
},
"progress": 52,
"calculation": {"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
},
"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [{"type": "INCONSISTENT_REFERENCE",
"info": "entity error",
"entities": [{"entity_key": "order_0001",
"entity_type": "ORDER",
"child_entity": { }
}
]
}
],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-02-21T19:45:00Z",
"creation_date": "2024-02-21T19:45:00Z"
}

Indicators update

Updating the experiment indicators.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Indicators update request.

Array ([ 0 .. 100 ] items)

string [ 2 .. 256 ] characters

Indicator key.

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

["total_statistics_cost",
"total_statistics_measurements_waiting_time"
]

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"external_routing": false
},
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
}
},
"progress": 52,
"calculation": {"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
},
"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [{"type": "INCONSISTENT_REFERENCE",
"info": "entity error",
"entities": [{"entity_key": "order_0001",
"entity_type": "ORDER",
"child_entity": { }
}
]
}
],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-02-21T19:45:00Z",
"creation_date": "2024-02-21T19:45:00Z"
}

Run calculation

Experiment calculation run.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
process_name required	string (basic_process) Default: "PLAN" Enum: "PLAN" "REPLAN" "ACTUALIZE" Example: ACTUALIZE Process name: `PLAN` - планирование `REPLAN` - перепланирование `ACTUALIZE` - актуализация

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
"specification": {"name": "new experiment 1000",
"comment": "",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "default",
"trip_start_time_strategy": "EARLIEST_FINISH",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"replan_settings": {"replan_strategy": {"reorder": false,
"plan_new_orders": false,
"create_new_trips": false
},
"trips_settings": {"configuration": "default",
"trip_start_time_strategy": "EARLIEST_FINISH",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"actualize_settings": {"geo_settings": {"geo_provider": "OSRM",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"total_statistics_max_transport_load_capacity_a",
"total_statistics_max_transport_load_capacity_b",
"total_statistics_max_transport_load_capacity_c",
"total_statistics_max_transport_load_mass",
"total_statistics_max_transport_load_volume",
"total_statistics_cargo_capacity_ratio_capacity_a",
"total_statistics_cargo_capacity_ratio_capacity_b",
"total_statistics_cargo_capacity_ratio_capacity_c",
"total_statistics_cargo_capacity_ratio_mass",
"total_statistics_cargo_capacity_ratio_volume",
"total_statistics_cost",
"total_statistics_measurements_arriving_time",
"total_statistics_measurements_departure_time",
"total_statistics_measurements_distance",
"total_statistics_measurements_driving_time",
"total_statistics_measurements_time_window_from",
"total_statistics_measurements_time_window_to",
"total_statistics_measurements_total_time",
"total_statistics_measurements_waiting_time",
"total_statistics_measurements_working_time",
"total_statistics_orders_count",
"total_statistics_performers_count",
"total_statistics_plan_orders_count",
"total_statistics_quality_hard_time_window_violations_after_count",
"total_statistics_quality_hard_time_window_violations_before_count",
"total_statistics_quality_soft_time_window_violations_after_count",
"total_statistics_quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-02-15T13:56:07.697Z",
"to": "2024-02-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-02-15T13:56:07.728Z",
"creation_date": "2024-02-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

Calculation stop

Calculation stop.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Run validation

Experiment validation run.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
process_name required	string (basic_process) Default: "PLAN" Enum: "PLAN" "REPLAN" "ACTUALIZE" Example: ACTUALIZE Process name: `PLAN` - планирование `REPLAN` - перепланирование `ACTUALIZE` - актуализация

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
"specification": {"name": "new experiment 1000",
"comment": "",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "default",
"trip_start_time_strategy": "EARLIEST_FINISH",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"replan_settings": {"replan_strategy": {"reorder": false,
"plan_new_orders": false,
"create_new_trips": false
},
"trips_settings": {"configuration": "default",
"trip_start_time_strategy": "EARLIEST_FINISH",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"actualize_settings": {"geo_settings": {"geo_provider": "OSRM",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"total_statistics_max_transport_load_capacity_a",
"total_statistics_max_transport_load_capacity_b",
"total_statistics_max_transport_load_capacity_c",
"total_statistics_max_transport_load_mass",
"total_statistics_max_transport_load_volume",
"total_statistics_cargo_capacity_ratio_capacity_a",
"total_statistics_cargo_capacity_ratio_capacity_b",
"total_statistics_cargo_capacity_ratio_capacity_c",
"total_statistics_cargo_capacity_ratio_mass",
"total_statistics_cargo_capacity_ratio_volume",
"total_statistics_cost",
"total_statistics_measurements_arriving_time",
"total_statistics_measurements_departure_time",
"total_statistics_measurements_distance",
"total_statistics_measurements_driving_time",
"total_statistics_measurements_time_window_from",
"total_statistics_measurements_time_window_to",
"total_statistics_measurements_total_time",
"total_statistics_measurements_waiting_time",
"total_statistics_measurements_working_time",
"total_statistics_orders_count",
"total_statistics_performers_count",
"total_statistics_plan_orders_count",
"total_statistics_quality_hard_time_window_violations_after_count",
"total_statistics_quality_hard_time_window_violations_before_count",
"total_statistics_quality_soft_time_window_violations_after_count",
"total_statistics_quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-02-15T13:56:07.697Z",
"to": "2024-02-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-02-15T13:56:07.728Z",
"creation_date": "2024-02-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

Import (XLSX)

Import (XLSX).

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

timezone

integer<int32> [ -12 .. 12 ]

Default: 0

Example: timezone=3

Timezone.

Request Body schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
required

Data (XLSX).

string<byte> (file_xlsx)

File with data in XLSX format.

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"external_routing": false
},
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
}
},
"progress": 52,
"calculation": {"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
},
"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [{"type": "INCONSISTENT_REFERENCE",
"info": "entity error",
"entities": [{"entity_key": "order_0001",
"entity_type": "ORDER",
"child_entity": { }
}
]
}
],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-02-21T19:45:00Z",
"creation_date": "2024-02-21T19:45:00Z"
}

Import (JSON)

Importing new data from a VRt.Universal JSON file. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Data (JSON).

	Array of objects (location) [ 0 .. 15001 ] items unique List of locations used for orders and shifts.
	Array of objects (order) [ 0 .. 15001 ] items unique Orders list.
	Array of objects (performer) [ 0 .. 15001 ] items unique Available performers list.
	Array of objects (transport) [ 0 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Assignments list.
	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (plan_settings) Planning settings.
	object (replan_settings) Replanning settings.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
}
],
"orders": [{"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
}
],
"performers": [{"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
}
],
"transports": [{"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
}
],
"hardlinks": [{"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
}
],
"trips": [{"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
}
],
"facts": {"order_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"type": "ORDER_DONE",
"order_key": "order_01",
"demand_key": "order_01_demand_01"
}
],
"performer_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"performer_key": "performer_01",
"location_key": "location01"
}
]
},
"statistics": {"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"trips_statistics": [{"trip_key": "trip01",
"statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"stop_statistics": [{"location_key": "location01",
"demand_ids": ["demand01"
],
"stop_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"upload": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"download": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
],
"total_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
]
},
"external_routing": [ ],
"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"dataset_name": "custom_dataset_one"
}

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"external_routing": false
},
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
}
},
"progress": 52,
"calculation": {"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
},
"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [{"type": "INCONSISTENT_REFERENCE",
"info": "entity error",
"entities": [{"entity_key": "order_0001",
"entity_type": "ORDER",
"child_entity": { }
}
]
}
],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-02-21T19:45:00Z",
"creation_date": "2024-02-21T19:45:00Z"
}

Import by URL (JSON)

Importing new data from a VRt.Universal JSON file by url. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

url

required

string<uri>

Example: url=https://docs.edge.veeroute.tech/assets/files/case_1.json

Url to json file.

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"external_routing": false
},
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
}
},
"progress": 52,
"calculation": {"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
},
"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [{"type": "INCONSISTENT_REFERENCE",
"info": "entity error",
"entities": [{"entity_key": "order_0001",
"entity_type": "ORDER",
"child_entity": { }
}
]
}
],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-02-21T19:45:00Z",
"creation_date": "2024-02-21T19:45:00Z"
}

Import by tracecode

Importing new data from a VRt.Universal JSON file by tracecode. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
source required	string (import_source) Enum: "ACCOUNT" "ADMIN" Example: ACCOUNT Source.
tracecode required	string<uuid> Example: 11111111-2222-3333-4444-555555555555 Unique process identifier.
sample required	string (import_sample) Enum: "TASK" "FULL" Example: TASK Sample of loaded data - input task or input task + calculation result.

Responses

Response Schema: application/json

key required	string<uuid> (unique_key) Key, unique identifier.
required	object (experiment_specification) Experiment description.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
progress	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.
	object or null (experiment_calculation) Experiment calculation details.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) A flag indicating whether changes to the entity have been made relative to the original data. `true` - means that the data is original and has not been changed.
sharing	boolean (basic_sharing) Experiment sharing flag.
edit_date required	string<date-time> Last edit date and time in the ISO 8601 format.
creation_date required	string<date-time> Creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"name": "Exp_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"external_routing": false
},
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
}
},
"progress": 52,
"calculation": {"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
},
"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [{"type": "INCONSISTENT_REFERENCE",
"info": "entity error",
"entities": [{"entity_key": "order_0001",
"entity_type": "ORDER",
"child_entity": { }
}
]
}
],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-02-21T19:45:00Z",
"creation_date": "2024-02-21T19:45:00Z"
}

Export (XLSX)

Export (XLSX).

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

timezone

integer<int32> [ -12 .. 12 ]

Default: 0

Example: timezone=3

Timezone.

Responses

Response Schema: application/octet-stream

string<byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Export (JSON)

Export data from the experiment to a VRt.Universal JSON file.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Responses

Response Schema: application/json

	Array of objects (location) [ 0 .. 15001 ] items unique List of locations used for orders and shifts.
	Array of objects (order) [ 0 .. 15001 ] items unique Orders list.
	Array of objects (performer) [ 0 .. 15001 ] items unique Available performers list.
	Array of objects (transport) [ 0 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Assignments list.
	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (plan_settings) Planning settings.
	object (replan_settings) Replanning settings.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Response samples

Content type

application/json

{"locations": [{"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
}
],
"orders": [{"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
}
],
"performers": [{"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
}
],
"transports": [{"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
}
],
"hardlinks": [{"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
}
],
"trips": [{"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
}
],
"facts": {"order_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"type": "ORDER_DONE",
"order_key": "order_01",
"demand_key": "order_01_demand_01"
}
],
"performer_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"performer_key": "performer_01",
"location_key": "location01"
}
]
},
"statistics": {"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"trips_statistics": [{"trip_key": "trip01",
"statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"stop_statistics": [{"location_key": "location01",
"demand_ids": ["demand01"
],
"stop_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"upload": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"download": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
],
"total_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
]
},
"external_routing": [ ],
"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"dataset_name": "custom_dataset_one"
}

System

System functions. Auxiliary functionality common to all services.

Checking the availability

Checking the service availability.

Responses

Response Schema: application/json

health

required

number<double> [ 0 .. 1 ]

Current health.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

Getting the service version

Getting the service version.

Responses

Response Schema: application/json

major required	integer<int32> [ 1 .. 100 ] Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services).
minor required	integer<int32> [ 0 .. 111 ] Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service.
build required	string [ 1 .. 64 ] characters Build version. Contains backwards compatible bug fixes and docs update.

Response samples

200
404
429
500

Content type

application/json

{"major": 4,
"minor": 4,
"build": "1754RC"
}

Getting the documentation

Getting the file with this service documentation.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

File name.

Responses

Response Schema:
text/html

string (file_html)

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"resource_id": "resource_id",
"detail": {"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
}
}

Locations

Locations management.

Locations list

Getting a locations list.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_location_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 2 more Example: sort_field=ESSENCE_KEY Locations table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

locations filter.

Array of objects (table_location_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_location) [ 0 .. 15001 ] items A list.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "LOCATION",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"attributes": "key1:value1, key2:value2"
},
"elements": [{"essence_key": "key01",
"essence_type": "LOCATION",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"attributes": "key1:value1, key2:value2"
}
]
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Create location

Create location.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required	object (location) Location - unique geographical location of the object with accessibility parameters.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Request samples

Payload

Content type

application/json

{"location": {"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"location": {"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "LOCATION",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Update location

Updating the location by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required	object (location) Location - unique geographical location of the object with accessibility parameters.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Response Schema: application/json

required	object (location) Location - unique geographical location of the object with accessibility parameters.
	object (table_location_fields) Location fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"location": {"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"location": {"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "LOCATION",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Read location

Getting location information by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required	object (location) Location - unique geographical location of the object with accessibility parameters.
	object (table_location_fields) Location fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"location": {"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "LOCATION",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Remove location

Removing a location by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Location geopoints

Getting a geopoints.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.

Request Body schema: application/json
optional

Locations filter.

Array of objects (table_location_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (web_location_geopoint) [ 0 .. 60002 ] items A list of points.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"geopoints": [{"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"location_key": "location01",
"linked": true
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Orders

Orders management.

List orders

Getting a orders list.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_order_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 28 more Example: sort_field=ESSENCE_KEY Order table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Essence filter.

Array of objects (table_order_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_order) [ 0 .. 15001 ] items A list.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "ORDER",
"enabled": false,
"pristine": false,
"state": "PLANNED",
"type": "PD",
"hard_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"reward": 2343.3,
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ],
"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": ["ALL"
],
"box_restrictions": [ ],
"cargo_features": [ ],
"cargo_restrictions": [ ],
"demands_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2"
},
"elements": [{"essence_key": "key01",
"essence_type": "ORDER",
"enabled": false,
"pristine": false,
"state": "PLANNED",
"type": "PD",
"hard_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"reward": 2343.3,
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ],
"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": ["ALL"
],
"box_restrictions": [ ],
"cargo_features": [ ],
"cargo_restrictions": [ ],
"demands_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2"
}
]
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Create order

New essences creation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required	object (order) The order for delivery/transportation, contains a list of demands.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Request samples

Payload

Content type

application/json

{"order": {"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"order": {"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "ORDER",
"enabled": false,
"pristine": false,
"state": "PLANNED",
"type": "PD",
"hard_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"reward": 2343.3,
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ],
"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": ["ALL"
],
"box_restrictions": [ ],
"cargo_features": [ ],
"cargo_restrictions": [ ],
"demands_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Update order

Updating the essence by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required	object (order) The order for delivery/transportation, contains a list of demands.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Response Schema: application/json

required	object (order) The order for delivery/transportation, contains a list of demands.
	object (table_order_fields) Order\demand fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"order": {"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"order": {"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "ORDER",
"enabled": false,
"pristine": false,
"state": "PLANNED",
"type": "PD",
"hard_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"reward": 2343.3,
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ],
"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": ["ALL"
],
"box_restrictions": [ ],
"cargo_features": [ ],
"cargo_restrictions": [ ],
"demands_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Reading order

Getting order information by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required	object (order) The order for delivery/transportation, contains a list of demands.
	object (table_order_fields) Order\demand fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"order": {"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "ORDER",
"enabled": false,
"pristine": false,
"state": "PLANNED",
"type": "PD",
"hard_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"reward": 2343.3,
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ],
"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": ["ALL"
],
"box_restrictions": [ ],
"cargo_features": [ ],
"cargo_restrictions": [ ],
"demands_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Order removal

Removing a essence by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Order geopoints

Getting a geopoints.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.

Request Body schema: application/json
optional

Orders filter.

Array of objects (table_order_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (web_order_geopoint) [ 0 .. 60002 ] items A list of points.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"geopoints": [{"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"demand_type": "WORK",
"trip_key": "key01",
"trip_name": "1-ABC",
"stop_number": 10
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Enable orders

Enable orders in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Enable orders request.

Array ([ 0 .. 15001 ] items)

string or null (basic_essence_key) [ 1 .. 1024 ] characters

Default: null

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["key01"
]

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Disable orders

Disable orders in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Disable orders request.

Array ([ 0 .. 15001 ] items)

string or null (basic_essence_key) [ 1 .. 1024 ] characters

Default: null

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["key01"
]

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Performers

Performers management.

Performers list

Getting a performers list.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_performer_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 7 more Example: sort_field=ESSENCE_KEY Performers table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Performers filter.

Array of objects (table_performer_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_performer) [ 0 .. 15001 ] items A list.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"elements": [{"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
}
]
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Create performer

Create performer.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required	object (performer) Performer. Fulfills orders using transport.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Request samples

Payload

Content type

application/json

{"performer": {"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"performer": {"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Update performer

Updating the performer by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required	object (performer) Performer. Fulfills orders using transport.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Response Schema: application/json

required	object (performer) Performer. Fulfills orders using transport.
	object (table_performer_fields) Performer and shift fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"performer": {"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"performer": {"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Read performer

Getting performer information by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required	object (performer) Performer. Fulfills orders using transport.
	object (table_performer_fields) Performer and shift fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"performer": {"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Remove performer

Removing a performer by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Performer geopoints

Getting a geopoints.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.

Request Body schema: application/json
optional

Performers filter.

Array of objects (table_performer_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (web_performer_geopoint) [ 0 .. 60002 ] items A list of points.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"geopoints": [{"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"performer_key": "performer_01",
"shift_key": "shift01",
"point_type": "START",
"trip_key": "key01",
"trip_name": "1-ABC",
"stop_number": 10
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Enable performers

Enable performers in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Enable performers request.

Array ([ 0 .. 15001 ] items)

string or null (basic_essence_key) [ 1 .. 1024 ] characters

Default: null

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["key01"
]

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Disable performers

Disable performers in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Disable performers request.

Array ([ 0 .. 15001 ] items)

string or null (basic_essence_key) [ 1 .. 1024 ] characters

Default: null

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["key01"
]

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Transports

Transports management.

Transport list

Getting a transport list.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_transport_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 8 more Example: sort_field=ESSENCE_KEY Transport table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Transport filter.

Array of objects (table_transport_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_transport) [ 0 .. 15001 ] items A list.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "TRANSPORT",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"elements": [{"essence_key": "key01",
"essence_type": "TRANSPORT",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
}
]
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Create transport

New essences creation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required	object (transport) Transport. Used by performer for relocating and cargo transfer.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Request samples

Payload

Content type

application/json

{"transport": {"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"transport": {"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "TRANSPORT",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Update transport

Updating the essence by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required	object (transport) Transport. Used by performer for relocating and cargo transfer.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Response Schema: application/json

required	object (transport) Transport. Used by performer for relocating and cargo transfer.
	object (table_transport_fields) Transport\shift fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"transport": {"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"transport": {"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "TRANSPORT",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Reading transport

Getting transport information by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required	object (transport) Transport. Used by performer for relocating and cargo transfer.
	object (table_transport_fields) Transport\shift fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"transport": {"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "TRANSPORT",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Remove transport

Removing a transport by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Transport geopoints

Getting a geopoints.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.

Request Body schema: application/json
optional

Transports filter.

Array of objects (table_transport_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (web_transport_geopoint) [ 0 .. 60002 ] items A list of points.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"geopoints": [{"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"transport_key": "transport_01",
"shift_key": "shift01",
"point_type": "START",
"trip_key": "key01",
"trip_name": "1-ABC",
"stop_number": 10
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Enable transports

Enable transports in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Enable transports request.

Array ([ 0 .. 15001 ] items)

string or null (basic_essence_key) [ 1 .. 1024 ] characters

Default: null

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["key01"
]

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Disable transports

Disable transports in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Disable transports request.

Array ([ 0 .. 15001 ] items)

string or null (basic_essence_key) [ 1 .. 1024 ] characters

Default: null

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["key01"
]

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Hardlinks

Hardlinks management.

List hardlinks

Getting a hardlinks list.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_hardlink_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 4 more Example: sort_field=ESSENCE_KEY Hardlink table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Hardlinks filter.

Array of objects (table_hardlink_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_hardlink) [ 0 .. 15001 ] items A list of hardlinks.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "HARDLINK",
"enabled": false,
"pristine": false,
"element_type": "ORDER",
"elements_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC"
},
"elements": [{"essence_key": "key01",
"essence_type": "HARDLINK",
"enabled": false,
"pristine": false,
"element_type": "ORDER",
"elements_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC"
}
]
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Create hardlink

Create new hardlink.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required

object (hardlink)

Assignment required to associate entities in a single group. It can consist of two or more entities. Example:

driver assignment to the transport (connection between the performer's shifts and the transport).
order assignment to the performer (link the order to a performer's shift).
specifying the need to perform multiple orders during a single trip (linking orders to deliver them within one trip).

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Responses

Request samples

Payload

Content type

application/json

{"hardlink": {"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"hardlink": {"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
},
"fields": {"essence_key": "key01",
"essence_type": "HARDLINK",
"enabled": false,
"pristine": false,
"element_type": "ORDER",
"elements_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Update hardlink

Updating the hardlink by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required

object (hardlink)

Assignment required to associate entities in a single group. It can consist of two or more entities. Example:

driver assignment to the transport (connection between the performer's shifts and the transport).
order assignment to the performer (link the order to a performer's shift).
specifying the need to perform multiple orders during a single trip (linking orders to deliver them within one trip).

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Responses

Response Schema: application/json

required	object (hardlink) Assignment required to associate entities in a single group. It can consist of two or more entities. Example: driver assignment to the transport (connection between the performer's shifts and the transport). order assignment to the performer (link the order to a performer's shift). specifying the need to perform multiple orders during a single trip (linking orders to deliver them within one trip).
	object (table_hardlink_fields) Hardlink and element fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"hardlink": {"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"hardlink": {"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
},
"fields": {"essence_key": "key01",
"essence_type": "HARDLINK",
"enabled": false,
"pristine": false,
"element_type": "ORDER",
"elements_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Read hardlink

Getting hardlink information by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required	object (hardlink) Assignment required to associate entities in a single group. It can consist of two or more entities. Example: driver assignment to the transport (connection between the performer's shifts and the transport). order assignment to the performer (link the order to a performer's shift). specifying the need to perform multiple orders during a single trip (linking orders to deliver them within one trip).
	object (table_hardlink_fields) Hardlink and element fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"hardlink": {"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
},
"fields": {"essence_key": "key01",
"essence_type": "HARDLINK",
"enabled": false,
"pristine": false,
"element_type": "ORDER",
"elements_count": 1,
"trip_key": "key01",
"trip_name": "1-ABC"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Remove hardlink

Removing a essence by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Enable hardlinks

Enable hardlinks in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Enable hardlinks request.

Array ([ 0 .. 15001 ] items)

string or null (basic_essence_key) [ 1 .. 1024 ] characters

Default: null

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["key01"
]

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Disable hardlinks

Disable hardlinks in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Disable hardlinks request.

Array ([ 0 .. 15001 ] items)

string or null (basic_essence_key) [ 1 .. 1024 ] characters

Default: null

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["key01"
]

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Trips

Trips management.

Trip list

Getting a trips list.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_trip_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 28 more Example: sort_field=ESSENCE_KEY Trip table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Trip filter.

Array of objects (table_trip_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_trip) [ 0 .. 15001 ] items A list.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
},
"duration_range": {"from": "P1Y1M1DT2H12M34.3S",
"to": "P1Y1M1DT2H12M34.3S"
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "TRIP",
"enabled": false,
"pristine": false,
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2",
"cost": 1231.1,
"reward": 2343.3,
"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1
},
"elements": [{"essence_key": "key01",
"essence_type": "TRIP",
"enabled": false,
"pristine": false,
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2",
"cost": 1231.1,
"reward": 2343.3,
"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1
}
]
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Trip create

New essences creation.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required	object (trip) A trip is a sequence of states assigned to the specified performer driving the specified transport.
required	object (trip_statistics) Statistics for a specific trip.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Request samples

Payload

Content type

application/json

{"trip": {"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"stop_statistics": [{"location_key": "location01",
"demand_ids": ["demand01"
],
"stop_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"upload": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"download": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
],
"total_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"trip": {"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"stop_statistics": [{"location_key": "location01",
"demand_ids": ["demand01"
],
"stop_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"upload": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"download": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
],
"total_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
},
"fields": {"essence_key": "key01",
"essence_type": "TRIP",
"enabled": false,
"pristine": false,
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2",
"cost": 1231.1,
"reward": 2343.3,
"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Trip update

Updating the essence by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required	object (trip) A trip is a sequence of states assigned to the specified performer driving the specified transport.
required	object (trip_statistics) Statistics for a specific trip.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Response Schema: application/json

required	object (trip) A trip is a sequence of states assigned to the specified performer driving the specified transport.
required	object (trip_statistics) Statistics for a specific trip.
	object (table_trip_fields) Trip\stops fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"trip": {"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"stop_statistics": [{"location_key": "location01",
"demand_ids": ["demand01"
],
"stop_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"upload": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"download": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
],
"total_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"trip": {"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"stop_statistics": [{"location_key": "location01",
"demand_ids": ["demand01"
],
"stop_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"upload": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"download": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
],
"total_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
},
"fields": {"essence_key": "key01",
"essence_type": "TRIP",
"enabled": false,
"pristine": false,
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2",
"cost": 1231.1,
"reward": 2343.3,
"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Read trip

Getting trip information by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required	object (trip) A trip is a sequence of states assigned to the specified performer driving the specified transport.
required	object (trip_statistics) Statistics for a specific trip.
	object (table_trip_fields) Trip\stops fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"trip": {"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"stop_statistics": [{"location_key": "location01",
"demand_ids": ["demand01"
],
"stop_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"upload": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"download": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
],
"total_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
},
"fields": {"essence_key": "key01",
"essence_type": "TRIP",
"enabled": false,
"pristine": false,
"trip_name": "1-ABC",
"attributes": "key1:value1, key2:value2",
"cost": 1231.1,
"reward": 2343.3,
"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Remove trip

Removing a trip by key.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Trip tracks

Getting a tracks.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string<uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier.
tracks_type required	string (basic_tracks_type) Default: "LINE" Enum: "LINE" "ROAD" Example: ROAD Track type: `LINE` - connecting stop points in a straight line `ROAD` - connecting stop points along roads

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.

Request Body schema: application/json
optional

Trips filter.

Array of objects (table_trip_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (web_trip_track) [ 0 .. 15001 ] items A list of tracks.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
},
"duration_range": {"from": "P1Y1M1DT2H12M34.3S",
"to": "P1Y1M1DT2H12M34.3S"
}
}
]
}

Response samples

Content type

application/json

{"tracks": [{"geopoints": [{"latitude": 55.692789,
"longitude": 37.554554
}
],
"trip_key": "location01",
"trip_name": "1-ABC",
"performer_key": "performer_01",
"performer_shift_key": "performer_shift_01",
"transport_key": "transport_01",
"transport_shift_key": "transport_shift_01"
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Trips chart

Getting a trips for chart.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string<uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

offset	integer<int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer<int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_trip_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 28 more Example: sort_field=ESSENCE_KEY Trip table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Trips filter.

Array of objects (table_trip_filter) [ 0 .. 100 ] items

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (web_trip_chart) [ 0 .. 15001 ] items Data for chart.
required	object (table_list_stats) Statistics by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"datetime_range": {"from": "2024-02-21T08:45:00+03:00",
"to": "2024-02-21T19:45:00+03:00"
},
"int_range": {"from": 1,
"to": 100
},
"float_range": {"from": 1,
"to": 100
},
"bool_list": {"elements": [false
]
},
"string_list": {"elements": ["key01"
],
"strict": false
},
"enum_list": {"elements": ["key01"
]
},
"string_search": {"text": "key01",
"strict": false
},
"duration_range": {"from": "P1Y1M1DT2H12M34.3S",
"to": "P1Y1M1DT2H12M34.3S"
}
}
]
}

Response samples

Content type

application/json

{"charts": [{"trip": {"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"chart_demands": [{"demand_key": "demand_1",
"demand_type": "WORK"
}
]
}
],
"statistics": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Facts

Facts management.

VRt.Studio [ST] (6.20.2289)

Description

Entity relationship diagram

Explorer

Create folder

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Getting a filesystem

Authorizations:

Responses

Response Schema: application/json

Response samples

Experiment list

Authorizations:

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Update folder

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Folder removal

Authorizations:

path Parameters

Responses

Response samples

Experiment search

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Experiments

Create experiment

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Reading experiment

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Experiment update

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Experiment removal

Authorizations:

path Parameters

Responses

Response samples

Experiment duplicate

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Settings update

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
required

Request Body schema: application/json
required