VRt.Studio [ST] (7.9.2527)

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

Veeroute Studio API.

Veeroute company website

Description

Server part of the Veeroute Studio.

Entity relationship diagram

erd

Explorer

Data structure management.

Create folder

Create new folder.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Folder create request.

parent_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key of the folder in which the new folder will be created.
name required	string [ 1 .. 100 ] characters Example: "folder_1_new" New folder name.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Folder comment.

Responses

Response Schema: application/json

string <uuid> (unique_key)

New folder key.

Request samples

Payload

Content type

application/json

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

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) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
type required	string (folder_type) Enum: "ROOT" "FOLDER" Example: "FOLDER" Element type: `ROOT` - root object `FOLDER` - folder
name required	string [ 1 .. 100 ] characters Example: "folder_1" Folder name.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Folder comment.
required	object (folder_counters) Current folder counters.
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",
"counters": {"folders_count": 1,
"experiments_count": 3
},
"elements": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"type": "FOLDER",
"name": "MyFolder",
"counters": {"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. If the filter is empty, all experiments in the folder are returned. The results are sorted by editing time.
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_experiment_column_type) Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more Example: sort_field=CREATION_DATE Experiments table column name.
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_counters) Counters 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",
"assumptions": {"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true
},
"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-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"profit": 1,
"cost": 2256.053,
"reward": 3000.3,
"measurements": {"driving_time": "PT57M5S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H32M5S",
"distance": 38666,
"time_window": {"from": "2024-11-08T04:50:28Z",
"to": "2024-11-08T05:47:33Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0.006,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"quality": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"facts": 1,
"external_routing": false
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"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": {"calculation_progress": 52,
"calculation_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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "STUDIO",
"operation": "run_plan_calculation",
"time": "2024-11-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [ ],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-11-21T19:45:00Z",
"creation_date": "2024-11-21T19:45:00Z"
}
],
"counters": {"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) Example: "11111111-2222-3333-4444-555555555555" Key of the folder in which the new folder will be created.
name required	string [ 1 .. 100 ] characters Example: "folder_1_new" New folder name.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Folder comment.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
type required	string (folder_type) Enum: "ROOT" "FOLDER" Example: "FOLDER" Element type: `ROOT` - root object `FOLDER` - folder
name required	string [ 1 .. 100 ] characters Example: "folder_1" Folder name.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Folder comment.
required	object (folder_counters) Current folder counters.
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",
"comment": "long long long long text"
}

Response samples

Content type

application/json

{"key": "5fffc47c-8239-42c4-8a3f-95d0ed235173",
"type": "ROOT",
"name": "ROOT",
"counters": {"folders_count": 1,
"experiments_count": 3
},
"elements": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"type": "FOLDER",
"name": "MyFolder",
"counters": {"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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Folder specification

Getting a folder specification.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/json

parent_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key of the folder in which the new folder will be created.
name required	string [ 1 .. 100 ] characters Example: "folder_1_new" New folder name.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Folder comment.

Response samples

Content type

application/json

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

Experiment search

Experiment global search.

Authorizations:

ApiKeyAuth

query Parameters

filter required	string [ 3 .. 128 ] 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. If the filter is empty, an empty list is returned. By default the results are sorted by editing time.
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_experiment_column_type) Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more Example: sort_field=CREATION_DATE Experiments table column name.
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_counters) Counters 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",
"assumptions": {"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true
},
"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-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["total_statistics_cost",
"total_statistics_measurements_waiting_time"
],
"total_statistics": {"profit": 1,
"cost": 2256.053,
"reward": 3000.3,
"measurements": {"driving_time": "PT57M5S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H32M5S",
"distance": 38666,
"time_window": {"from": "2024-11-08T04:50:28Z",
"to": "2024-11-08T05:47:33Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0.006,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"quality": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"data_statistics": {"locations": 1,
"orders": 1,
"performers": 1,
"transports": 1,
"hardlinks": 1,
"trips": 1,
"facts": 1,
"external_routing": false
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"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": {"calculation_progress": 52,
"calculation_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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "STUDIO",
"operation": "run_plan_calculation",
"time": "2024-11-21T09:30:00+03:00"
}
},
"check": {"logical_errors": [ ],
"warnings": [ ]
},
"pristine": false,
"sharing": true,
"edit_date": "2024-11-21T19:45:00Z",
"creation_date": "2024-11-21T19:45:00Z"
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Batch delete folders

Batch delete folders.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

List of folder keys that need to be deleted.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Batch delete experiments

Batch delete experiments.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

List of experiment's keys that need to be deleted.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

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 Example: "Exp_1" Experiment name.
comment required	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Experiment comment.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key.

Responses

Response Schema: application/json

string <uuid> (unique_key)

New experiment key.

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) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-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 Example: "Exp_1" Experiment name.
comment required	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Experiment comment.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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": "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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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 Example: "Exp_1" Experiment name.
comment required	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Experiment comment.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Duplicated experiment key.

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) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"expectations": {"trip_start_time_strategy": "LOWEST_COST"
},
"assumptions": {"transport_speed_multipliers": [ ],
"transport_capacity_multipliers": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ],
"max_locations_limits_penalty": 25000
}
},
"geo_settings": {"geo_provider": "VRT",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true
},
"calculation_settings": {"max_calculation_time": "PT12M35S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 1
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
},
"actualize_settings": {"current_time": "2024-11-21T09:30:00+03:00",
"max_delay_duration": "PT1H30M"
}
}

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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

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) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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": "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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

Experiment neighbors

Experiment neighbors.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

sort_field	string (table_experiment_column_type) Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more Example: sort_field=CREATION_DATE Experiments table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

previous_experiment_key	string or null <uuid> Default: null Example: "11111111-2222-3333-4444-555555555555" The key of the previous experiment is in the same folder.
next_experiment_key	string or null <uuid> Default: null Example: "11111111-2222-3333-4444-555555555555" The key of the next experiment is in the same folder.

Response samples

Content type

application/json

{"previous_experiment_key": "11111111-2222-3333-4444-555555555555",
"next_experiment_key": "11111111-2222-3333-4444-555555555555"
}

Experiment path

Experiment path.

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) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
type required	string (folder_type) Enum: "ROOT" "FOLDER" Example: "FOLDER" Element type: `ROOT` - root object `FOLDER` - folder
name required	string [ 1 .. 100 ] characters Example: "folder_1" Folder name.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Folder comment.
required	object (folder_counters) Current folder counters.
elements	Array of objects (filesystem) [ 0 .. 101 ] items A list of child's elements.

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"type": "FOLDER",
"name": "folder_1",
"comment": "long long long long text",
"counters": {"folders_count": 12,
"experiments_count": 16
},
"elements": [{ }
]
}

Calculation history

Read calculation history.

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 ([ 0 .. 3000 ] items)

time required	string <date-time> Example: "2024-11-21T09:30:00+03:00" Date and time of receiving statistics in the ISO 8601 format.
required	object (general_statistics) Summary statistics for one or a set of trips.

Response samples

Content type

application/json

[{"time": "2024-11-21T09:30:00+03:00",
"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"attributes": [ ]
}
}
]

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) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

Run refine

Experiment refine 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) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

Run recalculate tracks

Starting recalculation of ROAD experiment tracks.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

query Parameters

tracks_full_segments

boolean

Default: false

Example: tracks_full_segments=true

Return a complete or simplified list of route segments.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

Import (XLSX)

Importing new data from an XLSX file. If an entity is already present in the experiment (determined by its key), it is updated; if not, a new one is created. The data time zone is taken from the XLSX file.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Request Body schema: application/octet-stream
required

Data (XLSX).

string <byte> (file_xlsx)

File with data in XLSX format.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

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_list) [ 0 .. 15001 ] items unique List of locations used for orders and shifts.
	Array of objects (order_list) [ 0 .. 15001 ] items unique List of orders that need to be completed.
	Array of objects (performer_list) [ 0 .. 15001 ] items unique Available performers list. The performer fulfills orders using transport.
	Array of objects (transport_list) [ 0 .. 15001 ] items unique Available transports list. Transport is used by the trip performer to fulfill orders.
	Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Assignments list.
	Array of objects (trip_list) [ 0 .. 15001 ] items unique Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
	Array of objects (fact_list) [ 0 .. 15001 ] items unique Trip list. A fact is an event that has occurred that affects further trip operations.
	object or null (plan_statistics) General statistics on the calculation result.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix `external_routing`, the `geo_settings` parameters are not taken into account.
	object (plan_settings) Planning settings.
	object (replan_settings) Replanning settings.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 55.713699,
"longitude": 37.621839
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 55.630721,
"longitude": 37.62493
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 55.722801,
"longitude": 37.674984
}
},
{"key": "location_storage",
"geopoint": {"latitude": 55.685853,
"longitude": 37.43181
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
},
"working_time": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-11-08T04:38:34Z",
"to": "2024-11-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-11-08T04:38:34Z",
"to": "2024-11-08T05:53:39Z"
}
},
"states": [{"time": "2024-11-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

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) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

Import by tracedata

Importing new data from a VRt.Universal JSON file by tracedata.process_code. 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.
process_code required	string <uuid> (process_code) 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) Example: "11111111-2222-3333-4444-555555555555" 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 ] Example: "52" 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 (calculation_state) Current calculation state.
	object or null (experiment_check) The result of checking the data on the experiment.
pristine required	boolean (basic_pristine) Example: "false" 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) Example: "true" Experiment sharing flag.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" 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",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"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": {"current_time": "2024-11-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"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",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2024-11-15T13:56:07.697Z",
"to": "2024-11-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"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": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"pristine": true,
"edit_date": "2024-11-15T13:56:07.728Z",
"creation_date": "2024-11-15T13:56:07.728Z",
"progress": 0,
"sharing": false
}

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> (timezone) [ -12 .. 12 ]

Default: 0

Example: timezone=3

Target time zone.

Responses

Response Schema: application/octet-stream

string <byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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_list) [ 0 .. 15001 ] items unique List of locations used for orders and shifts.
	Array of objects (order_list) [ 0 .. 15001 ] items unique List of orders that need to be completed.
	Array of objects (performer_list) [ 0 .. 15001 ] items unique Available performers list. The performer fulfills orders using transport.
	Array of objects (transport_list) [ 0 .. 15001 ] items unique Available transports list. Transport is used by the trip performer to fulfill orders.
	Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Assignments list.
	Array of objects (trip_list) [ 0 .. 15001 ] items unique Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
	Array of objects (fact_list) [ 0 .. 15001 ] items unique Trip list. A fact is an event that has occurred that affects further trip operations.
	object or null (plan_statistics) General statistics on the calculation result.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix `external_routing`, the `geo_settings` parameters are not taken into account.
	object (plan_settings) Planning settings.
	object (replan_settings) Replanning settings.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation.

Response samples

Content type

application/json

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 55.713699,
"longitude": 37.621839
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 55.630721,
"longitude": 37.62493
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 55.722801,
"longitude": 37.674984
}
},
{"key": "location_storage",
"geopoint": {"latitude": 55.685853,
"longitude": 37.43181
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
},
"working_time": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-11-07T21:00:00+00:00",
"to": "2024-11-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-11-08T04:38:34Z",
"to": "2024-11-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-11-08T04:38:34Z",
"to": "2024-11-08T05:53:39Z"
}
},
"states": [{"time": "2024-11-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2024-11-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2024-11-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "LOCATION",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"attributes": "key1:value1, key2:value2"
}
]
}
],
"counters": {"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.
	object or null (location_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 (location) Location - unique geographical location of the object with accessibility parameters.
	object or null (location_statistics) Statistics for a specific trip.
	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": "location_01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "PT1H45M",
"departure_duration": "PT1H45M",
"timetable": [{"work_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"limits": [{"key": "location_limit_constraint_01",
"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"min_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"max_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"min_transports": [{"count": 2,
"penalty": 2000
}
],
"max_transports": [{"count": 2,
"penalty": 2000
}
]
}
]
}
],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"location_statistics": {"location_key": "location_01",
"location_limits_penalty": 25000,
"total_cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"total_transports_statistics": {"count": 2,
"penalty": 2000
},
"limits_statistics": [{"location_limit_key": "location_limit_constraint_01",
"cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"transports_statistics": {"count": 2,
"penalty": 2000
},
"location_limit_penalty": 25000
}
]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"location": {"key": "location_01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "PT1H45M",
"departure_duration": "PT1H45M",
"timetable": [{"work_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"limits": [{"key": "location_limit_constraint_01",
"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"min_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"max_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"min_transports": [{"count": 2,
"penalty": 2000
}
],
"max_transports": [{"count": 2,
"penalty": 2000
}
]
}
]
}
],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"location_statistics": {"location_key": "location_01",
"location_limits_penalty": 25000,
"total_cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"total_transports_statistics": {"count": 2,
"penalty": 2000
},
"limits_statistics": [{"location_limit_key": "location_limit_constraint_01",
"cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"transports_statistics": {"count": 2,
"penalty": 2000
},
"location_limit_penalty": 25000
}
]
},
"fields": {"essence_key": "key01",
"essence_type": "LOCATION",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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.
	object or null (location_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 (location) Location - unique geographical location of the object with accessibility parameters.
	object or null (location_statistics) Statistics for a specific trip.
	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": "location_01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "PT1H45M",
"departure_duration": "PT1H45M",
"timetable": [{"work_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"limits": [{"key": "location_limit_constraint_01",
"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"min_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"max_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"min_transports": [{"count": 2,
"penalty": 2000
}
],
"max_transports": [{"count": 2,
"penalty": 2000
}
]
}
]
}
],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"location_statistics": {"location_key": "location_01",
"location_limits_penalty": 25000,
"total_cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"total_transports_statistics": {"count": 2,
"penalty": 2000
},
"limits_statistics": [{"location_limit_key": "location_limit_constraint_01",
"cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"transports_statistics": {"count": 2,
"penalty": 2000
},
"location_limit_penalty": 25000
}
]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"location": {"key": "location_01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "PT1H45M",
"departure_duration": "PT1H45M",
"timetable": [{"work_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"limits": [{"key": "location_limit_constraint_01",
"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"min_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"max_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"min_transports": [{"count": 2,
"penalty": 2000
}
],
"max_transports": [{"count": 2,
"penalty": 2000
}
]
}
]
}
],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"location_statistics": {"location_key": "location_01",
"location_limits_penalty": 25000,
"total_cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"total_transports_statistics": {"count": 2,
"penalty": 2000
},
"limits_statistics": [{"location_limit_key": "location_limit_constraint_01",
"cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"transports_statistics": {"count": 2,
"penalty": 2000
},
"location_limit_penalty": 25000
}
]
},
"fields": {"essence_key": "key01",
"essence_type": "LOCATION",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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 or null (location_statistics) Statistics for a specific trip.
	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": "location_01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "PT1H45M",
"departure_duration": "PT1H45M",
"timetable": [{"work_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"limits": [{"key": "location_limit_constraint_01",
"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"min_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"max_cargos": [{"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
}
],
"min_transports": [{"count": 2,
"penalty": 2000
}
],
"max_transports": [{"count": 2,
"penalty": 2000
}
]
}
]
}
],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
},
"location_statistics": {"location_key": "location_01",
"location_limits_penalty": 25000,
"total_cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"total_transports_statistics": {"count": 2,
"penalty": 2000
},
"limits_statistics": [{"location_limit_key": "location_limit_constraint_01",
"cargos_statistics": {"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"penalty": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"transports_statistics": {"count": 2,
"penalty": 2000
},
"location_limit_penalty": 25000
}
]
},
"fields": {"essence_key": "key01",
"essence_type": "LOCATION",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"strict": false
}
}
]
}

Response samples

Content type

application/json

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

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" … 9 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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"performer_features": [ ],
"transport_restrictions": [ ],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"elements": [{"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"performer_features": [ ],
"transport_restrictions": [ ],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
}
]
}
],
"counters": {"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

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-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"working_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT30D",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"rest_rules": {"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
}
},
"break_rules": {"first": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"relocating_duration_type": "CONTINUOUS"
},
"reset_location_keys": ["location_01"
],
"ignore_location_keys": ["location_01"
]
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3,
"demand_extra_durations": [{"demand_key": "demand01.1",
"additional_duration": "PT1H45M"
}
]
},
"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-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"working_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT30D",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"rest_rules": {"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
}
},
"break_rules": {"first": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"relocating_duration_type": "CONTINUOUS"
},
"reset_location_keys": ["location_01"
],
"ignore_location_keys": ["location_01"
]
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3,
"demand_extra_durations": [{"demand_key": "demand01.1",
"additional_duration": "PT1H45M"
}
]
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"performer_features": [ ],
"transport_restrictions": [ ],
"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-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"working_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT30D",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"rest_rules": {"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
}
},
"break_rules": {"first": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"relocating_duration_type": "CONTINUOUS"
},
"reset_location_keys": ["location_01"
],
"ignore_location_keys": ["location_01"
]
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3,
"demand_extra_durations": [{"demand_key": "demand01.1",
"additional_duration": "PT1H45M"
}
]
},
"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-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"working_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT30D",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"rest_rules": {"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
}
},
"break_rules": {"first": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"relocating_duration_type": "CONTINUOUS"
},
"reset_location_keys": ["location_01"
],
"ignore_location_keys": ["location_01"
]
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3,
"demand_extra_durations": [{"demand_key": "demand01.1",
"additional_duration": "PT1H45M"
}
]
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"performer_features": [ ],
"transport_restrictions": [ ],
"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-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"working_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT30D",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"rest_rules": {"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
}
},
"break_rules": {"first": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"consecutive": {"relocating_duration_sum": "PT1H45M",
"operating_duration_sum": "PT2H12M34.3S",
"duration": "PT1H45M"
},
"relocating_duration_type": "CONTINUOUS"
},
"reset_location_keys": ["location_01"
],
"ignore_location_keys": ["location_01"
]
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3,
"demand_extra_durations": [{"demand_key": "demand01.1",
"additional_duration": "PT1H45M"
}
]
},
"attributes": [ ]
},
"fields": {"essence_key": "key01",
"essence_type": "PERFORMER",
"enabled": false,
"pristine": false,
"working_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"performer_features": [ ],
"transport_restrictions": [ ],
"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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"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
}
],
"counters": {"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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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" … 9 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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "TRANSPORT",
"enabled": false,
"pristine": false,
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"transport_features": [ ],
"performer_restrictions": [ ],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
},
"elements": [{"essence_key": "key01",
"essence_type": "TRANSPORT",
"enabled": false,
"pristine": false,
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"transport_features": [ ],
"performer_restrictions": [ ],
"trips_count": 1,
"attributes": "key1:value1, key2:value2"
}
]
}
],
"counters": {"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

Response Schema: application/json

required	object (transport) Transport. Used by performer for relocating and cargo transfer.
	object (table_transport_fields) Transport 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

{"transport": {"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"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-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"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,
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"transport_features": [ ],
"performer_restrictions": [ ],
"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 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

{"transport": {"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"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-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"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,
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"transport_features": [ ],
"performer_restrictions": [ ],
"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 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

{"transport": {"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"start_location_key": "start_location_01",
"finish_location_key": "finish_location_01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 11,
"volume": 22,
"capacity_a": 11,
"capacity_b": 22,
"capacity_c": 31
}
},
"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,
"availability_time": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "1-ABC",
"location_keys": ["key01"
],
"transport_features": [ ],
"performer_restrictions": [ ],
"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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"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
}
],
"counters": {"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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"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-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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"
}
]
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Delete orders

Removing orders from the 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

Request to delete orders.

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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

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

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": "location_01",
"duration": "PT1H45M",
"reward": 199.9,
"hard_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-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": "location_01",
"duration": "PT1H45M",
"reward": 199.9,
"hard_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-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-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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": "location_01",
"duration": "PT1H45M",
"reward": 199.9,
"hard_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-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": "location_01",
"duration": "PT1H45M",
"reward": 199.9,
"hard_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-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-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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": "location_01",
"duration": "PT1H45M",
"reward": 199.9,
"hard_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-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-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"soft_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_drop_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_pickup_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-21T19:45:00+03:00"
},
"general_work_time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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"
}
]
}

Deleting one order

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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"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
}
],
"counters": {"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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"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"
}
]
}
],
"counters": {"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

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"
}
]
}

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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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" … 30 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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"strict": false
}
}
]
}

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,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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
}
]
}
],
"counters": {"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 set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
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 set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
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": "trip-0000-9999",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"states": [{"time": "2024-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box01",
"cargo_key": "cargo01",
"cargo_action_type": "ADD"
}
],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [{"location_key": "location_01",
"stop_demands": [{"demand_key": "demand_key_01",
"event_key": "event_key_01",
"demand_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"upload": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"download": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
}
],
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"trip": {"key": "trip-0000-9999",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"states": [{"time": "2024-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box01",
"cargo_key": "cargo01",
"cargo_action_type": "ADD"
}
],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [{"location_key": "location_01",
"stop_demands": [{"demand_key": "demand_key_01",
"event_key": "event_key_01",
"demand_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"upload": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"download": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
}
],
"attributes": [ ]
},
"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,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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 set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
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 set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
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": "trip-0000-9999",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"states": [{"time": "2024-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box01",
"cargo_key": "cargo01",
"cargo_action_type": "ADD"
}
],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [{"location_key": "location_01",
"stop_demands": [{"demand_key": "demand_key_01",
"event_key": "event_key_01",
"demand_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"upload": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"download": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
}
],
"attributes": [ ]
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"trip": {"key": "trip-0000-9999",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"states": [{"time": "2024-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box01",
"cargo_key": "cargo01",
"cargo_action_type": "ADD"
}
],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [{"location_key": "location_01",
"stop_demands": [{"demand_key": "demand_key_01",
"event_key": "event_key_01",
"demand_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"upload": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"download": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
}
],
"attributes": [ ]
},
"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,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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 set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
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": "trip-0000-9999",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"states": [{"time": "2024-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box01",
"cargo_key": "cargo01",
"cargo_action_type": "ADD"
}
],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [{"location_key": "location_01",
"stop_demands": [{"demand_key": "demand_key_01",
"event_key": "event_key_01",
"demand_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"measurements": {"time_window": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"upload": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"download": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
}
],
"attributes": [ ]
},
"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,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": {"from": "2024-11-21T08:45:00+03:00",
"to": "2024-11-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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Load custom tracks

Load custom tracks.

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
optional

Tracks list.

required

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

A list of tracks.

Responses

Request samples

Payload

Content type

application/json

{"tracks": [{"geotrack": [{"latitude": 55.692789,
"longitude": 37.554554,
"time": "2024-11-21T09:30:00+03:00"
}
],
"trip_key": "location_01",
"trip_name": "1-ABC",
"performer_key": "performer_01",
"performer_shift_key": "performer_shift_01",
"transport_key": "transport_01",
"transport_shift_key": "transport_shift_01"
}
]
}

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Remove custom tracks

Remove custom all tracks.

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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-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" "CUSTOM" Example: ROAD Track type: `LINE` - connecting stop points in a straight line `ROAD` - connecting stop points along roads `EXTERNAL` - externally loaded custom tracks

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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"tracks": [{"geotrack": [{"latitude": 55.692789,
"longitude": 37.554554,
"time": "2024-11-21T09:30:00+03:00"
}
],
"trip_key": "location_01",
"trip_name": "1-ABC",
"performer_key": "performer_01",
"performer_shift_key": "performer_shift_01",
"transport_key": "transport_01",
"transport_shift_key": "transport_shift_01"
}
],
"counters": {"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" … 30 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_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"charts": [{"trip": {"key": "trip-0000-9999",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-11-21T09:30:00+03:00",
"to": "2024-11-21T19:45:00Z"
}
},
"states": [{"time": "2024-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box01",
"cargo_key": "cargo01",
"cargo_action_type": "ADD"
}
],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
},
"chart_demands": [{"demand_key": "demand_1",
"demand_type": "WORK"
}
]
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Facts

Facts management.

List of facts

Getting a facts 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_fact_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 7 more Example: sort_field=ESSENCE_KEY Fact table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Facts filter.

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

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_fact) [ 0 .. 15001 ] items A list of facts.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "some-text",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "key01",
"essence_type": "FACT",
"enabled": false,
"pristine": false,
"type": "NEW_LOCATION",
"order_key": "key01",
"demand_key": "key01",
"performer_key": "key01",
"location_key": "key01",
"trip_key": "key01",
"trip_name": "1-ABC"
},
"elements": [{"essence_key": "key01",
"essence_type": "FACT",
"enabled": false,
"pristine": false,
"type": "NEW_LOCATION",
"order_key": "key01",
"demand_key": "key01",
"performer_key": "key01",
"location_key": "key01",
"trip_key": "key01",
"trip_name": "1-ABC"
}
]
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Delete facts

Removing facts from the 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

Request to delete facts.

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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Create fact

Create new fact.

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 (fact) The fact about the order is the action taken with the order or its part (demand).
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Response Schema: application/json

required	object (fact) The fact about the order is the action taken with the order or its part (demand).
	object (table_fact_fields) Fact fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"fact": {"key": "fact_01",
"time": "2024-11-21T09:30:00+03:00",
"type": "NEW_LOCATION",
"trip_key": "trip_01",
"order_key": "order_01",
"demand_key": "order_01_demand_01",
"performer_key": "performer_01",
"location_key": "location_01"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"fact": {"key": "fact_01",
"time": "2024-11-21T09:30:00+03:00",
"type": "NEW_LOCATION",
"trip_key": "trip_01",
"order_key": "order_01",
"demand_key": "order_01_demand_01",
"performer_key": "performer_01",
"location_key": "location_01"
},
"fields": {"essence_key": "key01",
"essence_type": "FACT",
"enabled": false,
"pristine": false,
"type": "NEW_LOCATION",
"order_key": "key01",
"demand_key": "key01",
"performer_key": "key01",
"location_key": "key01",
"trip_key": "key01",
"trip_name": "1-ABC"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Update fact

Updating the fact 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 (fact) The fact about the order is the action taken with the order or its part (demand).
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Responses

Response Schema: application/json

required	object (fact) The fact about the order is the action taken with the order or its part (demand).
	object (table_fact_fields) Fact fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"fact": {"key": "fact_01",
"time": "2024-11-21T09:30:00+03:00",
"type": "NEW_LOCATION",
"trip_key": "trip_01",
"order_key": "order_01",
"demand_key": "order_01_demand_01",
"performer_key": "performer_01",
"location_key": "location_01"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Response samples

Content type

application/json

{"fact": {"key": "fact_01",
"time": "2024-11-21T09:30:00+03:00",
"type": "NEW_LOCATION",
"trip_key": "trip_01",
"order_key": "order_01",
"demand_key": "order_01_demand_01",
"performer_key": "performer_01",
"location_key": "location_01"
},
"fields": {"essence_key": "key01",
"essence_type": "FACT",
"enabled": false,
"pristine": false,
"type": "NEW_LOCATION",
"order_key": "key01",
"demand_key": "key01",
"performer_key": "key01",
"location_key": "key01",
"trip_key": "key01",
"trip_name": "1-ABC"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Read fact

Getting fact 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 (fact) The fact about the order is the action taken with the order or its part (demand).
	object (table_fact_fields) Fact fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"fact": {"key": "fact_01",
"time": "2024-11-21T09:30:00+03:00",
"type": "NEW_LOCATION",
"trip_key": "trip_01",
"order_key": "order_01",
"demand_key": "order_01_demand_01",
"performer_key": "performer_01",
"location_key": "location_01"
},
"fields": {"essence_key": "key01",
"essence_type": "FACT",
"enabled": false,
"pristine": false,
"type": "NEW_LOCATION",
"order_key": "key01",
"demand_key": "key01",
"performer_key": "key01",
"location_key": "key01",
"trip_key": "key01",
"trip_name": "1-ABC"
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

Deleting one fact

Removing a fact 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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Enable facts

Enable facts 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 facts 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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Disable facts

Disable facts 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 facts 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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

ExternalRouting

Routing matrix management.

Create externalrouting

Create new external routing.

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.

Array ([ 0 .. 16 ] items)

transport_type

required

string (transport_type)

Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more

Example: "CAR"

Transport types:

CAR - car
TRUCK_1500 - truck with permissible weight 1500 kg
TRUCK_3000 - truck with permissible weight 3000 kg
TRUCK_5000 - truck with permissible weight 5000 kg
TRUCK_10000 - truck with permissible weight 10000 kg
TRUCK_20000 - truck with permissible weight 20000 kg
TRUCK_10000_L75_H35_W24_6000 - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg
TRUCK_18000_L95_H40_W26_11000 - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg
TRUCK_26000_L120_H40_W26_8000 - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg
TRUCK_GARBAGE_1 - truck for transporting garbage (type 1)
TRUCK_GARBAGE_2 - truck for transporting garbage (type 2)
TUK_TUK - tuk-tuk
BICYCLE - bicycle
PEDESTRIAN - pedestrian
PUBLIC_TRANSPORT - public transport
TELEPORT - teleport (instant movement between points)

Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.

required

object (routing_matrix)

Routing matrix. Contains durations and distances between points.

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Update externalrouting

Updating the externalrouting.

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.

Array ([ 0 .. 16 ] items)

transport_type

required

string (transport_type)

Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more

Example: "CAR"

Transport types:

CAR - car
TRUCK_1500 - truck with permissible weight 1500 kg
TRUCK_3000 - truck with permissible weight 3000 kg
TRUCK_5000 - truck with permissible weight 5000 kg
TRUCK_10000 - truck with permissible weight 10000 kg
TRUCK_20000 - truck with permissible weight 20000 kg
TRUCK_10000_L75_H35_W24_6000 - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg
TRUCK_18000_L95_H40_W26_11000 - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg
TRUCK_26000_L120_H40_W26_8000 - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg
TRUCK_GARBAGE_1 - truck for transporting garbage (type 1)
TRUCK_GARBAGE_2 - truck for transporting garbage (type 2)
TUK_TUK - tuk-tuk
BICYCLE - bicycle
PEDESTRIAN - pedestrian
PUBLIC_TRANSPORT - public transport
TELEPORT - teleport (instant movement between points)

Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.

required

object (routing_matrix)

Routing matrix. Contains durations and distances between points.

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Read externalrouting

Getting externalrouting information.

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 ([ 0 .. 16 ] items)

transport_type

required

string (transport_type)

Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more

Example: "CAR"

Transport types:

CAR - car
TRUCK_1500 - truck with permissible weight 1500 kg
TRUCK_3000 - truck with permissible weight 3000 kg
TRUCK_5000 - truck with permissible weight 5000 kg
TRUCK_10000 - truck with permissible weight 10000 kg
TRUCK_20000 - truck with permissible weight 20000 kg
TRUCK_10000_L75_H35_W24_6000 - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg
TRUCK_18000_L95_H40_W26_11000 - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg
TRUCK_26000_L120_H40_W26_8000 - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg
TRUCK_GARBAGE_1 - truck for transporting garbage (type 1)
TRUCK_GARBAGE_2 - truck for transporting garbage (type 2)
TUK_TUK - tuk-tuk
BICYCLE - bicycle
PEDESTRIAN - pedestrian
PUBLIC_TRANSPORT - public transport
TELEPORT - teleport (instant movement between points)

Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.

required

object (routing_matrix)

Routing matrix. Contains durations and distances between points.

Response samples

Content type

application/json

[ ]

Deleting externalrouting

Removing externalrouting.

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": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Backups

Bulk data export and import.

Folder export

Export folder with experiments.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/octet-stream

string <byte> (file_zip)

ZIP archive with data.

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Folder import

Import folder with experiments. The folder should not be of type ROOT and should be empty.

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/octet-stream
required

Data (ZIP).

string <byte> (file_zip)

ZIP archive with data.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-11-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

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 ]

Example: "0.999"

The current health indicator of the service.

0.0 means the service is not ready to perform tasks.
1.0 means the service is fully ready to perform tasks.

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 ] Example: "7" 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 ] Example: "5" 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 Example: "3754RC" Build version. Contains backwards compatible bug fixes and docs update.

Response samples

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 5,
"build": "3754RC"
}

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_key": "resource_key",
"detail": {"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
}
}
}

VRt.Studio [ST] (7.9.2527)

Description

Entity relationship diagram

Explorer

Create folder

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

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

Folder specification

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Experiment search

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Batch delete folders

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Batch delete experiments

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Experiments

Create experiment

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

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 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/json
required

Request Body schema: application/json
required