VRt.Studio [ST] (7.10.2580)

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

Программный интерфейс для инструмента Veeroute Studio.

Сайт компании Veeroute

Описание

Серверная часть Veeroute Studio.

Диаграмма сущностей

erd

Explorer

Управление структурой данных.

Создание папки

Создание новой папки.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание папки.

parent_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки, в которой будет создана новая папка.
name required	string [ 1 .. 100 ] characters Example: "folder_1_new" Название новой папки.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Комментарий к папке.

Responses

Response Schema: application/json

string <uuid> (unique_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"

Чтение структуры папок

Получение структуры папок.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
type required	string (folder_type) Enum: "ROOT" "FOLDER" Example: "FOLDER" Тип элемента: `ROOT` - корневой объект `FOLDER` - папка
name required	string [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Комментарий к папке.
required	object (folder_counters) Статистика по текущей папке.
elements	Array of objects (filesystem) [ 0 .. 101 ] items Список дочерних элементов.

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

Список экспериментов

Получение списка экспериментов.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

query Parameters

filter	string [ 1 .. 64 ] characters Example: filter=example text Фильтр для поиска по текстовым полям - возвращаются только те эксперименты, у которых в названии или описании содержится подстрока из фильтра. Если фильтр пустой - возвращаются все эксперименты в папке. Результат сортируется по времени редактирования.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_experiment_column_type) Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more Example: sort_field=CREATION_DATE Название колонки в таблице с экспериментами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	Array of objects (experiment) [ 0 .. 101 ] items Список экспериментов.
required	object (table_list_counters) Счетчики по списку.

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

Обновление папки

Переименование и перемещение папки.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление папки.

parent_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки, в которой будет создана новая папка.
name required	string [ 1 .. 100 ] characters Example: "folder_1_new" Название новой папки.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Комментарий к папке.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
type required	string (folder_type) Enum: "ROOT" "FOLDER" Example: "FOLDER" Тип элемента: `ROOT` - корневой объект `FOLDER` - папка
name required	string [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Комментарий к папке.
required	object (folder_counters) Статистика по текущей папке.
elements	Array of objects (filesystem) [ 0 .. 101 ] items Список дочерних элементов.

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

Удаление папки

Удаление папки по ключу.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

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

Информация о папке

Получение информации о папке.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Responses

Response Schema: application/json

parent_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки, в которой будет создана новая папка.
name required	string [ 1 .. 100 ] characters Example: "folder_1_new" Название новой папки.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Комментарий к папке.

Response samples

Content type

application/json

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

Поиск экспериментов

Поиск экспериментов по всем вложенным папкам.

Authorizations:

ApiKeyAuth

query Parameters

filter required	string [ 3 .. 128 ] characters Example: filter=example text Фильтр для поиска по текстовым полям - возвращаются только те эксперименты, у которых в названии или описании содержится подстрока из фильтра. Если фильтр пустой - возвращается пустой список. По умолчанию результат сортируется по времени редактирования.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_experiment_column_type) Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more Example: sort_field=CREATION_DATE Название колонки в таблице с экспериментами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	Array of objects (experiment) [ 0 .. 101 ] items Список экспериментов.
required	object (table_list_counters) Счетчики по списку.

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

Массовое удаление папок

Массовое удаление папок.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Список ключей папок, которые необходимо удалить.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Ключ, уникальный идентификатор.

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

Массовое удаление экспериментов

Массовое удаление экспериментов.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Список ключей экспериментов, которые необходимо удалить.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Ключ, уникальный идентификатор.

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

Управление экспериментами

Создание эксперимента

Создание нового эксперимента.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание эксперимента.

name required	string [ 1 .. 100 ] characters Example: "Exp_1" Название эксперимента.
comment required	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Комментарий к эксперименту.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки типа `FOLDER`, в которой находится эксперимент.

Responses

Response Schema: application/json

string <uuid> (unique_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"

Чтение эксперимента

Получение информации об эксперименте по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Обновление эксперимента

Переименование \ перемещение эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление описания эксперимента.

name required	string [ 1 .. 100 ] characters Example: "Exp_1" Название эксперимента.
comment required	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Комментарий к эксперименту.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки типа `FOLDER`, в которой находится эксперимент.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Удаление эксперимента

Удаление эксперимента по ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

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

Дублирование эксперимента

Дублирование эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на дублирование эксперимента.

name required	string [ 1 .. 100 ] characters Example: "Exp_1" Название эксперимента.
comment required	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Комментарий к эксперименту.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки типа `FOLDER`, в которой находится эксперимент.

Responses

Response Schema: application/json

string <uuid> (unique_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"

Обновление настроек

Обновление настроек эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление настроек эксперимента.

required	object (plan_settings) Настройки планирования.
required	object (replan_settings) Настройки перепланирования.
required	object (actualize_settings) Настройки актуализации.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

Request samples

Payload

Content type

application/json

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

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
}

Обновление индикаторов

Обновление индикаторов.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление индикаторов эксперимента.

Array ([ 0 .. 100 ] items)

string [ 2 .. 256 ] characters

Ключ индикатора.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Получение соседних экспериментов

Получение соседних экспериментов.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

sort_field	string (table_experiment_column_type) Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more Example: sort_field=CREATION_DATE Название колонки в таблице с экспериментами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

previous_experiment_key	string or null <uuid> Default: null Example: "11111111-2222-3333-4444-555555555555" Ключ предыдущего эксперимента в той же папке.
next_experiment_key	string or null <uuid> Default: null Example: "11111111-2222-3333-4444-555555555555" Ключ следующего эксперимента в той же папке.

Response samples

Content type

application/json

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

Получение пути эксперимента

Получение пути эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
type required	string (folder_type) Enum: "ROOT" "FOLDER" Example: "FOLDER" Тип элемента: `ROOT` - корневой объект `FOLDER` - папка
name required	string [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Комментарий к папке.
required	object (folder_counters) Статистика по текущей папке.
elements	Array of objects (filesystem) [ 0 .. 101 ] items Список дочерних элементов.

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": [{ }
]
}

История расчета

Получение истории расчета эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

Array ([ 0 .. 3000 ] items)

time required	string <date-time> Example: "2024-11-21T09:30:00+03:00" Дата и время получения статистики в соответствии с ISO 8601.
required	object (general_statistics) Суммарная статистика по одному или совокупности рейсов.

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

Запуск расчета

Запуск расчета эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
process_name required	string (basic_process) Default: "PLAN" Enum: "PLAN" "REPLAN" "ACTUALIZE" Example: ACTUALIZE Название процесса обработки данных: `PLAN` - планирование `REPLAN` - перепланирование `ACTUALIZE` - актуализация

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Остановка расчета

Остановка расчета.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

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

Запуск валидации

Запуск валидации данных эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
process_name required	string (basic_process) Default: "PLAN" Enum: "PLAN" "REPLAN" "ACTUALIZE" Example: ACTUALIZE Название процесса обработки данных: `PLAN` - планирование `REPLAN` - перепланирование `ACTUALIZE` - актуализация

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Запуск очистки

Запуск очистки данных эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
process_name required	string (basic_process) Default: "PLAN" Enum: "PLAN" "REPLAN" "ACTUALIZE" Example: ACTUALIZE Название процесса обработки данных: `PLAN` - планирование `REPLAN` - перепланирование `ACTUALIZE` - актуализация

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Запуск перерасчета треков

Запуск перерасчета треков ROAD эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

tracks_full_segments

boolean

Default: false

Example: tracks_full_segments=true

Возвращать полный или краткий список сегментов пути.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Импорт (XLSX)

Импорт новых данных из файла формата XLSX. Если сущность уже присутствует в эксперименте (определяется по ее ключу) - она обновляется, если нет - создается новая. Временная зона данных берется из файла XLSX.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/octet-stream
required

Данные (XLSX).

string <byte> (file_xlsx)

Файл с данными в формате XLSX.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Импорт (JSON)

Импорт новых данных из файла формата VRt.Universal JSON. Если сущность уже присутствует в эксперименте (определяется по ее ключу) - она обновляется, если нет - создается новая.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Данные (JSON).

	Array of objects (location_list) [ 0 .. 15001 ] items unique Список локаций, которые используются в заказах и сменах.
	Array of objects (order_list) [ 0 .. 15001 ] items unique Список заказов, которые необходимо выполнить.
	Array of objects (performer_list) [ 0 .. 15001 ] items unique Список доступных исполнителей. Исполнитель выполняет заказы используя транспорт.
	Array of objects (transport_list) [ 0 .. 15001 ] items unique Список доступного транспорта. Транспорт используется исполнителем рейса для выполнения заказов.
	Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Список назначений.
	Array of objects (trip_list) [ 0 .. 15001 ] items unique Список рейсов. Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
	Array of objects (fact_list) [ 0 .. 15001 ] items unique Список фактов. Факт - это произошедшее событие, которое влияет на дальнейшие выполнение рейсов.
	object or null (plan_statistics) Общая статистика по результату расчета.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique Список матриц времен и расстояний для каждого типа транспорта, которые указаны в данных. Матрица должна описывать все локации для каждого типа транспорта из данных. При указании внешней матрицы маршрутизации `external_routing` не учитываются параметры `geo_settings`.
	object (plan_settings) Настройки планирования.
	object (replan_settings) Настройки перепланирования.
	object (actualize_settings) Настройки актуализации.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" Название набора данных. Техническое поле, не влияющее на расчет.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Импорт по URL (JSON)

Импорт новых данных из файла формата VRt.Universal JSON по ссылке. Если сущность уже присутствует в эксперименте (определяется по ее ключу) - она обновляется, если нет - создается новая.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

url

required

string <uri>

Example: url=https://docs.edge7.veeroute.cloud/assets/files/case_1.json

Url json файла.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

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
}

Импорт по tracedata

Импорт новых данных из файла формата VRt.Universal JSON по tracedata.process_code. Если сущность уже присутствует в эксперименте (определяется по ее ключу) - она обновляется, если нет - создается новая.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
source required	string (import_source) Enum: "ACCOUNT" "ADMIN" Example: ACCOUNT Источник.
process_code required	string <uuid> (process_code) Example: 11111111-2222-3333-4444-555555555555 Уникальный идентификатор процесса.
sample required	string (import_sample) Enum: "TASK" "FULL" Example: TASK Выборка загружаемых данных - входная задача или входная задача + результат расчета.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (experiment_specification) Описание эксперимента.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	object or null (calculation_state) Текущее состояние расчета.
	object or null (experiment_check) Результат проверки данных по эксперименту.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date required	string <date-time> Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.

Окружение для интеграции и ознакомления с новой функциональностью

https://api.edge7.veeroute.cloud/studio/experiments/{experiment_key}/import/json-tracedata/{source}/{process_code}/{sample}

Основное окружение

https://api.prod7.veeroute.cloud/studio/experiments/{experiment_key}/import/json-tracedata/{source}/{process_code}/{sample}

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
}

Экспорт (XLSX)

Экспортировать (XLSX).

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

timezone

integer <int32> (timezone) [ -12 .. 12 ]

Default: 0

Example: timezone=3

Целевая временная зона данных.

Responses

Response Schema: application/octet-stream

string <byte> (file_xlsx)

Файл с данными в формате XLSX.

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

Экспорт (JSON)

Экспортировать данные из эксперимента в файл формата VRt.Universal JSON.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

	Array of objects (location_list) [ 0 .. 15001 ] items unique Список локаций, которые используются в заказах и сменах.
	Array of objects (order_list) [ 0 .. 15001 ] items unique Список заказов, которые необходимо выполнить.
	Array of objects (performer_list) [ 0 .. 15001 ] items unique Список доступных исполнителей. Исполнитель выполняет заказы используя транспорт.
	Array of objects (transport_list) [ 0 .. 15001 ] items unique Список доступного транспорта. Транспорт используется исполнителем рейса для выполнения заказов.
	Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Список назначений.
	Array of objects (trip_list) [ 0 .. 15001 ] items unique Список рейсов. Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
	Array of objects (fact_list) [ 0 .. 15001 ] items unique Список фактов. Факт - это произошедшее событие, которое влияет на дальнейшие выполнение рейсов.
	object or null (plan_statistics) Общая статистика по результату расчета.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique Список матриц времен и расстояний для каждого типа транспорта, которые указаны в данных. Матрица должна описывать все локации для каждого типа транспорта из данных. При указании внешней матрицы маршрутизации `external_routing` не учитываются параметры `geo_settings`.
	object (plan_settings) Настройки планирования.
	object (replan_settings) Настройки перепланирования.
	object (actualize_settings) Настройки актуализации.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" Название набора данных. Техническое поле, не влияющее на расчет.

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

Управление локациями.

Создание локации

Создание локации.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание нового локации.

required	object (location) Локация - уникальное географическое местоположение объекта с параметрами доступности.
	object or null (location_statistics) Статистика по загрузке локации.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (location) Локация - уникальное географическое местоположение объекта с параметрами доступности.
	object or null (location_statistics) Статистика по загрузке локации.
	object (table_location_fields) Табличные поля локации.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"location": {"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
},
"fields": {"essence_key": "performer_1_location",
"enabled": true
}
}

Response samples

Content type

application/json

{"location": {"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
},
"fields": {"essence_key": "performer_1_location",
"enabled": true
}
}

Обновление локации

Обновление локации по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление локации.

required	object (location) Локация - уникальное географическое местоположение объекта с параметрами доступности.
	object or null (location_statistics) Статистика по загрузке локации.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (location) Локация - уникальное географическое местоположение объекта с параметрами доступности.
	object or null (location_statistics) Статистика по загрузке локации.
	object (table_location_fields) Табличные поля локации.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"location": {"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
},
"fields": {"essence_key": "performer_1_location",
"enabled": true
}
}

Response samples

Content type

application/json

{"location": {"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
},
"fields": {"essence_key": "performer_1_location",
"enabled": true
}
}

Чтение локации

Получение информации о локации по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (location) Локация - уникальное географическое местоположение объекта с параметрами доступности.
	object or null (location_statistics) Статистика по загрузке локации.
	object (table_location_fields) Табличные поля локации.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"location": {"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
},
"fields": {"essence_key": "performer_1_location",
"enabled": true
}
}

Удаление локации

Удаление локации по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

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

Список локаций

Получение списка локаций.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_location_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 4 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с локациями.
sort_customfield	string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "INT_1" … 9 more Example: sort_customfield=NONE Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр локаций.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_location) [ 0 .. 15001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Геоточки локаций

Получение списка геоточек.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр локаций.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_location_geopoint) [ 0 .. 60002 ] items Список точек.
required	object (table_list_counters) Счетчики по списку сущностей.
required	object (table_list_counters_detail) Счетчики по списку точек.

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
}
},
"geopoints_counters": {"total": 1
}
}

Performers

Управление исполнителями.

Создание исполнителя

Создание исполнителя.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание нового исполнителя.

required	object (performer) Исполнитель. Выполняет заказы, используя транспорт.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (performer) Исполнитель. Выполняет заказы, используя транспорт.
	object (table_performer_fields) Табличные поля исполнителя и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"performer": {"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"
}
}
]
},
"fields": {"essence_key": "performer_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"performer": {"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"
}
}
]
},
"fields": {"essence_key": "performer_1",
"enabled": true
}
}

Обновление исполнителя

Обновление исполнителя по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление исполнителя.

required	object (performer) Исполнитель. Выполняет заказы, используя транспорт.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (performer) Исполнитель. Выполняет заказы, используя транспорт.
	object (table_performer_fields) Табличные поля исполнителя и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"performer": {"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"
}
}
]
},
"fields": {"essence_key": "performer_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"performer": {"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"
}
}
]
},
"fields": {"essence_key": "performer_1",
"enabled": true
}
}

Чтение исполнителя

Получение информации об исполнителе по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (performer) Исполнитель. Выполняет заказы, используя транспорт.
	object (table_performer_fields) Табличные поля исполнителя и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"performer": {"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"
}
}
]
},
"fields": {"essence_key": "performer_1",
"enabled": true
}
}

Удаление исполнителя

Удаление исполнителя по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

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

Список исполнителей

Получение списка исполнителей.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_performer_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 11 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с исполнителями.
sort_customfield	string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "INT_1" … 9 more Example: sort_customfield=NONE Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр исполнителей.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_performer) [ 0 .. 15001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Включение исполнителей

Включение исполнителей в расчет.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение исполнителей.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Выключение исполнителей

Выключение исполнителей из расчета.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение исполнителей.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Геоточки исполнителей

Получение списка геоточек.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр исполнителей.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_performer_geopoint) [ 0 .. 60002 ] items Список точек.
required	object (table_list_counters) Счетчики по списку сущностей.
required	object (table_list_counters_detail) Счетчики по списку точек.

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": "X1-ABC",
"stop_number": 10
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"geopoints_counters": {"total": 1
}
}

Transports

Управление транспортом.

Создание транспорта

Создание транспорта.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание нового транспорта.

required	object (transport) Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (transport) Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.
	object (table_transport_fields) Табличные поля транспорта и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"transport": {"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"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
},
"fields": {"essence_key": "transport_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"transport": {"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"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
},
"fields": {"essence_key": "transport_1",
"enabled": true
}
}

Обновление транспорта

Обновление транспорта по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление транспорта.

required	object (transport) Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (transport) Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.
	object (table_transport_fields) Табличные поля транспорта и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"transport": {"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"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
},
"fields": {"essence_key": "transport_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"transport": {"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"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
},
"fields": {"essence_key": "transport_1",
"enabled": true
}
}

Чтение транспорта

Получение информации о транспорте по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (transport) Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.
	object (table_transport_fields) Табличные поля транспорта и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"transport": {"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"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
},
"fields": {"essence_key": "transport_1",
"enabled": true
}
}

Удаление транспорта

Удаление транспорта по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

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

Список транспорта

Получение списка транспорта.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_transport_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 11 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с транспортом.
sort_customfield	string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "INT_1" … 9 more Example: sort_customfield=NONE Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр транспорта.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_transport) [ 0 .. 15001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Включение транспорта

Включение транспорта в расчет.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение транспорта.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Выключение транспорта

Выключение транспорта из расчета.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение транспорта.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Геоточки транспорта

Получение списка геоточек.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр транспорта.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_transport_geopoint) [ 0 .. 60002 ] items Список точек.
required	object (table_list_counters) Счетчики по списку сущностей.
required	object (table_list_counters_detail) Счетчики по списку точек.

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": "X1-ABC",
"stop_number": 10
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"geopoints_counters": {"total": 1
}
}

Orders

Управление заказами.

Создание заказа

Создание заказа.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

required	object (order) Заказ на перемещение груза, содержит список заявок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (order) Заказ на перемещение груза, содержит список заявок.
	object (table_order_fields) Табличные поля заказа и заявок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"order": {"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"order": {"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Обновление заказа

Обновление сущности по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

required	object (order) Заказ на перемещение груза, содержит список заявок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (order) Заказ на перемещение груза, содержит список заявок.
	object (table_order_fields) Табличные поля заказа и заявок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"order": {"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"order": {"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Чтение заказа

Получение информации о заказе по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (order) Заказ на перемещение груза, содержит список заявок.
	object (table_order_fields) Табличные поля заказа и заявок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"order": {"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2024-11-08T05:00:00+00:00",
"to": "2024-11-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Удаление одного заказа

Удаление заказа по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

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

Список заказов

Получение списка заказов.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_order_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 30 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с заказами.
sort_customfield	string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "INT_1" … 9 more Example: sort_customfield=NONE Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр заказов.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_order) [ 0 .. 15001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Удаление заказов

Удаление заказов из эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на удаление заказов.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Включение заказов

Включение заказов в расчет.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение заказов.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Выключение заказов

Выключение заказов из расчета.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение заказов.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Геоточки заказов

Получение списка геоточек.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр заказов.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_order_geopoint) [ 0 .. 60002 ] items Список точек.
required	object (table_list_counters) Счетчики по списку сущностей.
required	object (table_list_counters_detail) Счетчики по списку точек.

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": "X1-ABC",
"stop_number": 10
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"geopoints_counters": {"total": 1
}
}

Hardlinks

Управление назначениями.

Создание назначения

Создание назначения.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

required

object (hardlink)

Назначение, необходимое чтобы связать сущности в одну группу. Может состоять из двух сущностей или более. Пример применения:

назначение водителя на транспорт (связь смен исполнителя и траспорта).
назначение заказа на исполнителя (связь заказа со сменой исполнителя).
указание необходимости выполнять несколько заказов в одном рейсе (связь заказов между собой).

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

Список связанных сущностей.

Responses

Response Schema: application/json

required	object (hardlink) Назначение, необходимое чтобы связать сущности в одну группу. Может состоять из двух сущностей или более. Пример применения: назначение водителя на транспорт (связь смен исполнителя и траспорта). назначение заказа на исполнителя (связь заказа со сменой исполнителя). указание необходимости выполнять несколько заказов в одном рейсе (связь заказов между собой).
	object (table_hardlink_fields) Табличные поля связи и связанных сущностей.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"hardlink": {"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
},
"fields": {"essence_key": "hardlink_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"hardlink": {"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
},
"fields": {"essence_key": "hardlink_1",
"enabled": true
}
}

Обновление назначения

Обновление назначения по ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

required

object (hardlink)

Назначение, необходимое чтобы связать сущности в одну группу. Может состоять из двух сущностей или более. Пример применения:

назначение водителя на транспорт (связь смен исполнителя и траспорта).
назначение заказа на исполнителя (связь заказа со сменой исполнителя).
указание необходимости выполнять несколько заказов в одном рейсе (связь заказов между собой).

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

Список связанных сущностей.

Responses

Response Schema: application/json

required	object (hardlink) Назначение, необходимое чтобы связать сущности в одну группу. Может состоять из двух сущностей или более. Пример применения: назначение водителя на транспорт (связь смен исполнителя и траспорта). назначение заказа на исполнителя (связь заказа со сменой исполнителя). указание необходимости выполнять несколько заказов в одном рейсе (связь заказов между собой).
	object (table_hardlink_fields) Табличные поля связи и связанных сущностей.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"hardlink": {"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
},
"fields": {"essence_key": "hardlink_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"hardlink": {"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
},
"fields": {"essence_key": "hardlink_1",
"enabled": true
}
}

Чтение назначения

Получение информации о назначении по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (hardlink) Назначение, необходимое чтобы связать сущности в одну группу. Может состоять из двух сущностей или более. Пример применения: назначение водителя на транспорт (связь смен исполнителя и траспорта). назначение заказа на исполнителя (связь заказа со сменой исполнителя). указание необходимости выполнять несколько заказов в одном рейсе (связь заказов между собой).
	object (table_hardlink_fields) Табличные поля связи и связанных сущностей.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"hardlink": {"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
},
"fields": {"essence_key": "hardlink_1",
"enabled": true
}
}

Удаление назначения

Удаление назначения по ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

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

Список назначений

Получение списка назначений.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_hardlink_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 5 more Example: sort_field=ESSENCE_KEY Название колонки в таблице со связями.
sort_customfield	string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "INT_1" … 9 more Example: sort_customfield=NONE Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр назначений.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_hardlink) [ 0 .. 15001 ] items Список связей.
required	object (table_list_counters) Счетчики по списку.

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": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Включение назначений

Включение назначений в расчет.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение назначений.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Выключение назначений

Выключение назначений из расчета.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение назначений.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Управление рейсами.

Создание рейса

Создание рейса.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
required	object (trip_statistics) Статистика по конкретному рейсу.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
required	object (trip_statistics) Статистика по конкретному рейсу.
	object (table_trip_fields) Табличные поля рейса и остановок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"trip": {"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"states": [{"time": "2024-11-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"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_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip_1",
"general_statistics": {"cost": 6795.37,
"reward": 3000.3,
"profit": -3795.07,
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT39M15S",
"waiting_time": "PT0S",
"working_time": "PT35M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H14M15S",
"distance": 34037
},
"trips_count": 1,
"performers_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 4,
"locations_count": 4,
"cargo_capacity_sum": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"cargo_capacity_ratio": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"average_speed": 0,
"round_trips_count": 1
},
"load_statistics": {"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"stop_demands": [{"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
},
{"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"stop_demands": [{"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"demand_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:10:00Z"
},
"driving_time": "PT20M26S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M26S",
"distance": 17110
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"stop_demands": [{"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"demand_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:10:00Z",
"to": "2024-11-08T05:30:56Z"
},
"driving_time": "PT10M56S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT20M56S",
"distance": 9897
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"stop_demands": [{"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"demand_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:30:56Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT7M53S",
"waiting_time": "PT0S",
"working_time": "PT15M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT22M53S",
"distance": 7030
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"fields": {"essence_key": "trip_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"trip": {"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"states": [{"time": "2024-11-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"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_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip_1",
"general_statistics": {"cost": 6795.37,
"reward": 3000.3,
"profit": -3795.07,
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT39M15S",
"waiting_time": "PT0S",
"working_time": "PT35M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H14M15S",
"distance": 34037
},
"trips_count": 1,
"performers_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 4,
"locations_count": 4,
"cargo_capacity_sum": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"cargo_capacity_ratio": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"average_speed": 0,
"round_trips_count": 1
},
"load_statistics": {"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"stop_demands": [{"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
},
{"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"stop_demands": [{"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"demand_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:10:00Z"
},
"driving_time": "PT20M26S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M26S",
"distance": 17110
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"stop_demands": [{"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"demand_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:10:00Z",
"to": "2024-11-08T05:30:56Z"
},
"driving_time": "PT10M56S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT20M56S",
"distance": 9897
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"stop_demands": [{"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"demand_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:30:56Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT7M53S",
"waiting_time": "PT0S",
"working_time": "PT15M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT22M53S",
"distance": 7030
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"fields": {"essence_key": "trip_1",
"enabled": true
}
}

Обновление рейса

Обновление рейса по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
required	object (trip_statistics) Статистика по конкретному рейсу.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
required	object (trip_statistics) Статистика по конкретному рейсу.
	object (table_trip_fields) Табличные поля рейса и остановок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"trip": {"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"states": [{"time": "2024-11-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"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_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip_1",
"general_statistics": {"cost": 6795.37,
"reward": 3000.3,
"profit": -3795.07,
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT39M15S",
"waiting_time": "PT0S",
"working_time": "PT35M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H14M15S",
"distance": 34037
},
"trips_count": 1,
"performers_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 4,
"locations_count": 4,
"cargo_capacity_sum": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"cargo_capacity_ratio": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"average_speed": 0,
"round_trips_count": 1
},
"load_statistics": {"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"stop_demands": [{"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
},
{"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"stop_demands": [{"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"demand_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:10:00Z"
},
"driving_time": "PT20M26S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M26S",
"distance": 17110
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"stop_demands": [{"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"demand_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:10:00Z",
"to": "2024-11-08T05:30:56Z"
},
"driving_time": "PT10M56S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT20M56S",
"distance": 9897
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"stop_demands": [{"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"demand_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:30:56Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT7M53S",
"waiting_time": "PT0S",
"working_time": "PT15M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT22M53S",
"distance": 7030
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"fields": {"essence_key": "trip_1",
"enabled": true
}
}

Response samples

Content type

application/json

{"trip": {"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"states": [{"time": "2024-11-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"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_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip_1",
"general_statistics": {"cost": 6795.37,
"reward": 3000.3,
"profit": -3795.07,
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT39M15S",
"waiting_time": "PT0S",
"working_time": "PT35M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H14M15S",
"distance": 34037
},
"trips_count": 1,
"performers_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 4,
"locations_count": 4,
"cargo_capacity_sum": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"cargo_capacity_ratio": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"average_speed": 0,
"round_trips_count": 1
},
"load_statistics": {"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"stop_demands": [{"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
},
{"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"stop_demands": [{"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"demand_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:10:00Z"
},
"driving_time": "PT20M26S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M26S",
"distance": 17110
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"stop_demands": [{"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"demand_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:10:00Z",
"to": "2024-11-08T05:30:56Z"
},
"driving_time": "PT10M56S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT20M56S",
"distance": 9897
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"stop_demands": [{"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"demand_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:30:56Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT7M53S",
"waiting_time": "PT0S",
"working_time": "PT15M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT22M53S",
"distance": 7030
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"fields": {"essence_key": "trip_1",
"enabled": true
}
}

Чтение рейса

Получение информации о рейсе по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
required	object (trip_statistics) Статистика по конкретному рейсу.
	object (table_trip_fields) Табличные поля рейса и остановок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"trip": {"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
}
},
"states": [{"time": "2024-11-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2024-11-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"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_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2024-11-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip_1",
"general_statistics": {"cost": 6795.37,
"reward": 3000.3,
"profit": -3795.07,
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT39M15S",
"waiting_time": "PT0S",
"working_time": "PT35M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H14M15S",
"distance": 34037
},
"trips_count": 1,
"performers_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 4,
"locations_count": 4,
"cargo_capacity_sum": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"cargo_capacity_ratio": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"average_speed": 0,
"round_trips_count": 1
},
"load_statistics": {"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"stop_demands": [{"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
},
{"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"demand_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T04:39:34Z"
},
"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"stop_demands": [{"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"demand_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:00:00Z",
"to": "2024-11-08T05:10:00Z"
},
"measurements": {"time_window": {"from": "2024-11-08T04:39:34Z",
"to": "2024-11-08T05:10:00Z"
},
"driving_time": "PT20M26S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M26S",
"distance": 17110
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"stop_demands": [{"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"demand_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:20:56Z",
"to": "2024-11-08T05:30:56Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:10:00Z",
"to": "2024-11-08T05:30:56Z"
},
"driving_time": "PT10M56S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT20M56S",
"distance": 9897
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"stop_demands": [{"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"demand_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
}
}
],
"stop_time_window": {"from": "2024-11-08T05:38:49Z",
"to": "2024-11-08T05:53:49Z"
},
"measurements": {"time_window": {"from": "2024-11-08T05:30:56Z",
"to": "2024-11-08T05:53:49Z"
},
"driving_time": "PT7M53S",
"waiting_time": "PT0S",
"working_time": "PT15M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT22M53S",
"distance": 7030
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"fields": {"essence_key": "trip_1",
"enabled": true
}
}

Удаление рейса

Удаление рейса по ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

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

Список рейсов

Получение списка рейсов.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_trip_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 31 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с рейсами.
sort_customfield	string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "INT_1" … 9 more Example: sort_customfield=NONE Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр рейсов.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_trip) [ 0 .. 15001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Пути рейсов

Получение путей.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
tracks_type required	string (basic_tracks_type) Default: "LINE" Enum: "LINE" "ROAD" "CUSTOM" Example: ROAD Тип трека: `LINE` - соединение точек остановок по прямой `ROAD` - соединение точек остановок по дорогам `EXTERNAL` - пользовательские треки

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр рейсов.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_trip_track) [ 0 .. 15001 ] items Список треков.
required	object (table_list_counters) Счетчики по списку.

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": "X1-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
}
}
}

Диаграмма рейсов

Получение рейсов для отображения на диаграмме.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_trip_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 31 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с рейсами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр рейсов.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_trip_chart) [ 0 .. 15001 ] items Данные для диаграммы.
required	object (table_list_counters) Счетчики по списку.

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": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Загрузка пользовательских треков

Загрузка пользовательских треков.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
optional

Список треков.

required

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

Список треков.

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": "X1-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": [ ]
}

Удаление пользовательских треков

Удаление пользовательских всех треков.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

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

Список остановок рейсов

Получение списка остановок рейса.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_trip_stop_column_type) Enum: "ESSENCE_KEY" "DRIVING_TIME" "WAITING_TIME" … 11 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с остановками рейса.
sort_customfield	string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "INT_1" … 9 more Example: sort_customfield=NONE Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр остановок рейса.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_trip_stop) [ 0 .. 15001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Facts

Управление фактами.

Создание факта

Создание факта.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

required	object (fact) Факт о заказе - совершенное действие с заказом или его частью (заявкой).
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (fact) Факт о заказе - совершенное действие с заказом или его частью (заявкой).
	object (table_fact_fields) Табличные поля факта.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"fact": {"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2024-11-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
},
"fields": {"essence_key": "fact_01",
"enabled": true
}
}

Response samples

Content type

application/json

{"fact": {"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2024-11-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
},
"fields": {"essence_key": "fact_01",
"enabled": true
}
}

Обновление факта

Обновление факта по ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

required	object (fact) Факт о заказе - совершенное действие с заказом или его частью (заявкой).
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Responses

Response Schema: application/json

required	object (fact) Факт о заказе - совершенное действие с заказом или его частью (заявкой).
	object (table_fact_fields) Табличные поля факта.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"fact": {"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2024-11-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
},
"fields": {"essence_key": "fact_01",
"enabled": true
}
}

Response samples

Content type

application/json

{"fact": {"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2024-11-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
},
"fields": {"essence_key": "fact_01",
"enabled": true
}
}

Чтение факта

Получение информации о факте по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (fact) Факт о заказе - совершенное действие с заказом или его частью (заявкой).
	object (table_fact_fields) Табличные поля факта.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"fact": {"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2024-11-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
},
"fields": {"essence_key": "fact_01",
"enabled": true
}
}

Удаление одного факта

Удаление факта по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Ключ, уникальный идентификатор.

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

Список фактов

Получение списка фактов.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_fact_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 8 more Example: sort_field=ESSENCE_KEY Название колонки в таблице со фактами.
sort_customfield	string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "INT_1" … 9 more Example: sort_customfield=NONE Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр фактов.

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

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_fact) [ 0 .. 15001 ] items Список связей.
required	object (table_list_counters) Счетчики по списку.

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_type": "FACT",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"type": "NEW_LOCATION",
"order_key": "key01",
"demand_key": "key01",
"performer_key": "key01",
"location_key": "key01",
"trip_key": "key01",
"trip_name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_1": "2024-11-21T18:00:00+03:00",
"datetime_2": "2024-11-21T18:00:00+03:00",
"int_1": 1,
"int_2": 1,
"float_1": 2343.3,
"float_2": 2343.3,
"duration_1": "PT2H12M34.3S",
"duration_2": "PT2H12M34.3S",
"bool_1": true,
"bool_2": true,
"string_1": "key01",
"string_2": "key01"
}
},
"elements": [{"essence_type": "FACT",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"type": "NEW_LOCATION",
"order_key": "key01",
"demand_key": "key01",
"performer_key": "key01",
"location_key": "key01",
"trip_key": "key01",
"trip_name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_1": "2024-11-21T18:00:00+03:00",
"datetime_2": "2024-11-21T18:00:00+03:00",
"int_1": 1,
"int_2": 1,
"float_1": 2343.3,
"float_2": 2343.3,
"duration_1": "PT2H12M34.3S",
"duration_2": "PT2H12M34.3S",
"bool_1": true,
"bool_2": true,
"string_1": "key01",
"string_2": "key01"
}
}
]
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Удаление фактов

Удаление фактов из эксперимента.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на удаление фактов.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Включение фактов

Включение фактов в расчет.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение фактов.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Выключение фактов

Выключение фактов из расчета.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение фактов.

Array ([ 0 .. 15001 ] items)

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

Default: null

Ключ, уникальный идентификатор.

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

Управление матрицей маршрутизации.

Создание матриц маршрутизации

Создание матриц маршрутизации.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

Array ([ 0 .. 16 ] items)

transport_type

required

string (transport_type)

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

Example: "CAR"

Типы транспорта:

CAR - легковой автомобиль
TRUCK_1500 - грузовой автомобиль с разрешенной массой не более 1500 кг
TRUCK_3000 - грузовой автомобиль с разрешенной массой не более 3000 кг
TRUCK_5000 - грузовой автомобиль с разрешенной массой не более 5000 кг
TRUCK_10000 - грузовой автомобиль с разрешенной массой не более 10000 кг
TRUCK_20000 - грузовой автомобиль с разрешенной массой не более 20000 кг
TRUCK_10000_L75_H35_W24_6000 - грузовой автомобиль с разрешенной массой не более 10000 кг, габаритами 7.5 x 3.5 x 2.4 метров, допустимой нагрузкой на ось 6000 кг
TRUCK_18000_L95_H40_W26_11000 - грузовой автомобиль с разрешенной массой не более 18000 кг, габаритами 9.5 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 11000 кг
TRUCK_26000_L120_H40_W26_8000 - грузовой автомобиль с разрешенной массой не более 26000 кг, габаритами 12.0 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 8000 кг
TRUCK_GARBAGE_1 - грузовой автомобиль для перевозки мусора (тип 1)
TRUCK_GARBAGE_2 - грузовой автомобиль для перевозки мусора (тип 2)
TUK_TUK - моторикша
BICYCLE - велосипед
PEDESTRIAN - пешеход
PUBLIC_TRANSPORT - общественный транспорт
TELEPORT - телепорт (мгновенное перемещение между точками)

Разрешенная масса - это масса снаряженного транспорта с грузом и водителем, установленная предприятием-изготовителем в качестве максимально допустимой.

required

object (routing_matrix)

Матрица маршрутизации. Содержит времена и расстояний между точками.

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

Чтение матриц маршрутизации

Получение информации о факте.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

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"

Типы транспорта:

CAR - легковой автомобиль
TRUCK_1500 - грузовой автомобиль с разрешенной массой не более 1500 кг
TRUCK_3000 - грузовой автомобиль с разрешенной массой не более 3000 кг
TRUCK_5000 - грузовой автомобиль с разрешенной массой не более 5000 кг
TRUCK_10000 - грузовой автомобиль с разрешенной массой не более 10000 кг
TRUCK_20000 - грузовой автомобиль с разрешенной массой не более 20000 кг
TRUCK_10000_L75_H35_W24_6000 - грузовой автомобиль с разрешенной массой не более 10000 кг, габаритами 7.5 x 3.5 x 2.4 метров, допустимой нагрузкой на ось 6000 кг
TRUCK_18000_L95_H40_W26_11000 - грузовой автомобиль с разрешенной массой не более 18000 кг, габаритами 9.5 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 11000 кг
TRUCK_26000_L120_H40_W26_8000 - грузовой автомобиль с разрешенной массой не более 26000 кг, габаритами 12.0 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 8000 кг
TRUCK_GARBAGE_1 - грузовой автомобиль для перевозки мусора (тип 1)
TRUCK_GARBAGE_2 - грузовой автомобиль для перевозки мусора (тип 2)
TUK_TUK - моторикша
BICYCLE - велосипед
PEDESTRIAN - пешеход
PUBLIC_TRANSPORT - общественный транспорт
TELEPORT - телепорт (мгновенное перемещение между точками)

Разрешенная масса - это масса снаряженного транспорта с грузом и водителем, установленная предприятием-изготовителем в качестве максимально допустимой.

required

object (routing_matrix)

Матрица маршрутизации. Содержит времена и расстояний между точками.

Response samples

Content type

application/json

[ ]

Обновление матриц маршрутизации

Обновление матриц маршрутизации по ключу.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

Array ([ 0 .. 16 ] items)

transport_type

required

string (transport_type)

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

Example: "CAR"

Типы транспорта:

CAR - легковой автомобиль
TRUCK_1500 - грузовой автомобиль с разрешенной массой не более 1500 кг
TRUCK_3000 - грузовой автомобиль с разрешенной массой не более 3000 кг
TRUCK_5000 - грузовой автомобиль с разрешенной массой не более 5000 кг
TRUCK_10000 - грузовой автомобиль с разрешенной массой не более 10000 кг
TRUCK_20000 - грузовой автомобиль с разрешенной массой не более 20000 кг
TRUCK_10000_L75_H35_W24_6000 - грузовой автомобиль с разрешенной массой не более 10000 кг, габаритами 7.5 x 3.5 x 2.4 метров, допустимой нагрузкой на ось 6000 кг
TRUCK_18000_L95_H40_W26_11000 - грузовой автомобиль с разрешенной массой не более 18000 кг, габаритами 9.5 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 11000 кг
TRUCK_26000_L120_H40_W26_8000 - грузовой автомобиль с разрешенной массой не более 26000 кг, габаритами 12.0 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 8000 кг
TRUCK_GARBAGE_1 - грузовой автомобиль для перевозки мусора (тип 1)
TRUCK_GARBAGE_2 - грузовой автомобиль для перевозки мусора (тип 2)
TUK_TUK - моторикша
BICYCLE - велосипед
PEDESTRIAN - пешеход
PUBLIC_TRANSPORT - общественный транспорт
TELEPORT - телепорт (мгновенное перемещение между точками)

Разрешенная масса - это масса снаряженного транспорта с грузом и водителем, установленная предприятием-изготовителем в качестве максимально допустимой.

required

object (routing_matrix)

Матрица маршрутизации. Содержит времена и расстояний между точками.

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

Удаление матриц маршрутизации

Удаление матриц маршрутизации.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

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

UserSettings

Пользовательские настройки.

Установка активного ключа настроек пользователя

Установка активного ключа настроек пользователя.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Новый ключ.

string (basic_path_key) [ 1 .. 1024 ] characters

Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

settings_keys required	Array of strings (basic_path_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: "path-key-01" Список ключей настроек.
active_key	string or null (basic_path_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Request samples

Payload

Content type

application/json

"path-key-01"

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Чтение списка настроек пользователя

Чтение списка ключей настроек пользователя.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

settings_keys required	Array of strings (basic_path_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: "path-key-01" Список ключей настроек.
active_key	string or null (basic_path_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Обновление настроек пользователя

Обновление настроек пользователя.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (basic_path_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/json
required

Новые настройки.

property name*

additional property

any

Responses

Response Schema: application/json

property name*

additional property

any

Request samples

Payload

Content type

application/json

"{\"key1\":\"value1\"}"

Response samples

Content type

application/json

"{\"key1\":\"value1\"}"

Чтение настроек пользователя

Чтение настроек пользователя.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (basic_path_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Responses

Response Schema: application/json

property name*

additional property

any

Response samples

Content type

application/json

"{\"key1\":\"value1\"}"

Обновление настроек пользователя

Обновление настроек пользователя.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (basic_path_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/json
required

Новые настройки.

property name*

additional property

any

Responses

Response Schema: application/json

property name*

additional property

any

Request samples

Payload

Content type

application/json

"{\"key1\":\"value1\"}"

Response samples

Content type

application/json

"{\"key1\":\"value1\"}"

Удаление настроек пользователя

Удаление всех настроек пользователя.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (basic_path_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

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

CustomFields

Настройки конвертации пользовательских полей.

В таблице предусмотрены дополнительные колонки для отображения значений из атрибутов.

Данная настройка определяет правила конвертации значений атрибутов в соответствующие типизированные поля.

Конвертации происходит при чтении данных - поэтому правила конвертации не влияют на данные и их можно изменять в любой момент.

Установка активного ключа настроек полей

Установка активного ключа настроек полей.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Новый ключ.

string (basic_path_key) [ 1 .. 1024 ] characters

Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

settings_keys required	Array of strings (basic_path_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: "path-key-01" Список ключей настроек.
active_key	string or null (basic_path_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Request samples

Payload

Content type

application/json

"path-key-01"

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Чтение списка настроек полей

Чтение списка ключей настроек пользовательских полей.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

settings_keys required	Array of strings (basic_path_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: "path-key-01" Список ключей настроек.
active_key	string or null (basic_path_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Обновление настроек полей

Обновление настроек пользовательских полей.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (basic_path_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/json
required

Новые настройки.

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Responses

Response Schema: application/json

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Request samples

Payload

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Response samples

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Чтение настроек полей

Чтение настройки пользовательских полей.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (basic_path_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Responses

Response Schema: application/json

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Response samples

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Обновление настроек полей

Обновление настроек пользовательских полей.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (basic_path_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/json
required

Новые настройки.

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Responses

Response Schema: application/json

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Request samples

Payload

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Response samples

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Удаление настроек полей

Удаление настроек пользовательских полей.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (basic_path_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

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

Массовый экспорт и импорт данных.

Экспорт папки

Экспорт папки с экспериментами.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Responses

Response Schema: application/octet-stream

string <byte> (file_zip)

ZIP-архив с данными.

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

Импорт папки

Импорт папки с экспериментами. Папка не должна типа ROOT и должна быть пустой.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Request Body schema: application/octet-stream
required

Данные (ZIP).

string <byte> (file_zip)

ZIP-архив с данными.

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

Системные функции. Вспомогательный функционал, общий для всех сервисов.

Проверка доступности

Проверка доступности сервиса.

Responses

Response Schema: application/json

health

required

number <double> [ 0 .. 1 ]

Example: "0.999"

Текущий показатель здоровья сервиса.

0.0 означает неготовность сервиса выполнять задачи.
1.0 означает полную готовность сервиса для выполнения задач.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

Получение версии сервиса

Получение версии сервиса.

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" Версия продукта. В рамках одной версии гарантируется совместимость общих структур данных между сервисами. Изменение версии указывает на несовместимые с предыдущими версиями продукта (и, соответственно, всех сервисов) изменения.
minor required	integer <int32> [ 0 .. 111 ] Example: "15" Минорная версия сервиса. Изменение версии указывает на новую функциональность. Обновление имеет обратную совместимость в рамках мажорной версии сервиса.
build required	string [ 1 .. 64 ] characters Example: "3754RC" Версия сборки. Изменяется при обновлении документации и исправлении ошибок.

Response samples

200
404
429
500

Content type

application/json

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

Получение документации

Получение файла с документацией на этот сервис.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

Название файла.

Responses

Response Schema:
text/html

string (file_html)

Файл с данными в формате HTML.

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.10.2580)

Описание

Диаграмма сущностей

Explorer

Создание папки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Чтение структуры папок

Authorizations:

Responses

Response Schema: application/json

Response samples

Список экспериментов

Authorizations:

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Обновление папки

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Удаление папки

Authorizations:

path Parameters

Responses

Response samples

Информация о папке

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Поиск экспериментов

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Массовое удаление папок

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Массовое удаление экспериментов

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Experiments

Создание эксперимента

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Чтение эксперимента

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Обновление эксперимента

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