VRt.Studio [ST] (7.26.3024)

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

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

Описание

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

Зарезервированные атрибуты

Данные ключи атрибутов зарезервированы для определенной бизнес-логики:

Ключ атрибута	Родительская сущность	Назначение
`ICON_NAME`	location	Значение атрибута записывается в поле `web_location_geopoint.icon_name`
`FORCED_GEOPROVIDER`	geo_settings	Значение атрибута определяет провайдер геоданных для отрисовки рейсов на карте, который будет использоваться вместо указанного в поле `plan_settings.geo_settings.geo_provider`
`TRIP_VERIFIED`	trip	Значение атрибута показывает, был ли рейс проверен и утвержден вручную

Пример использования - переопределение геопровайдера для отрисовки рейсов в Studio:

{ "plan_settings": { "geo_settings": { "attributes": [ { "key": "FORCED_GEOPROVIDER", "value": "OSRM_EXTERNAL" } ] } } }

Роли

Ограничения по работе с виртуальной папкой:

После создания папка не может изменить владельца и компанию.
При создании новой папки не в ROOT она получает владельца и компанию из родительской папки.

Влияние роли аккаунта на виртуальную файловую систему:

ADMIN, PARTNER, USER, BOT

Доступ только к своим папкам (folder.owner_username = account.username) и файлам внутри этих папок
Возможность открывать на редактирование любые чужие файлы по прямой ссылке на файл

COMPANYOWNER

Доступ только к папкам своей компании (folder.owner_company_key = account.company_key) и файлам внутри этих папок
Возможность открывать на редактирование любые чужие файлы по прямой ссылке на файл

OVERLORD

Доступ ко всем папкам окружения (folder.owner_company_key = *) и файлам внутри этих папок

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

erd

Explorer

Управление виртуальной файловой системой.

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

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание папки. В поле parent_key необходимо указать ключ папки, в которой будет создана новая папка. Если parent_key не указан - папка создается в корне.

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Ключ родительской папки, `null` если папка корневая.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к папке.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Цвет папки.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-01-21T19:45:00Z" Дата и время автоматического удаления в соответствии с ISO 8601. Null означает что автоматическое удаление не происходит.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

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",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2026-01-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

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

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

Authorizations:

ApiKeyAuth

query Parameters

folder_key	string <uuid> (unique_key) Example: folder_key=11111111-2222-3333-4444-555555555555 Ключ родительской папки, если не указан - возвращается список корневых папок
filter	string [ 1 .. 64 ] characters Example: filter=example text Фильтр для поиска по текстовым полям - возвращаются только те папки, у которых содержится подстрока из фильтра: в названии папки в комментарии к папке
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (filesystem_column_type) Default: "NAME" Enum: "NAME" "OWNER_COMPANY_KEY" "OWNER_USERNAME" … 4 more Example: sort_field=CREATION_DATE Название колонки в таблице с папками.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	object (folder) Папка - элемент виртуальной файловой системы.
required	Array of objects (folder) [ 0 .. 2001 ] items Default: [] Список папок.
required	object (table_list_counters) Счетчики по списку.

Response samples

Content type

application/json

{"$ref": "explorer.json"
}

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

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

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	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Ключ родительской папки, `null` если папка корневая.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к папке.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Цвет папки.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-01-21T19:45:00Z" Дата и время автоматического удаления в соответствии с ISO 8601. Null означает что автоматическое удаление не происходит.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (folder) Папка - элемент виртуальной файловой системы.
required	Array of objects (folder) [ 0 .. 2001 ] items Default: [] Список папок.
required	object (table_list_counters) Счетчики по списку.

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2026-01-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

{"$ref": "explorer.json"
}

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

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response Schema: application/json

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Ключ родительской папки, `null` если папка корневая.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к папке.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Цвет папки.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-01-21T19:45:00Z" Дата и время автоматического удаления в соответствии с ISO 8601. Null означает что автоматическое удаление не происходит.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Response samples

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2026-01-21T19:45:00Z",
"attributes": [ ]
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response Schema: application/json

required

Array of objects (folder) [ 0 .. 1000 ] items

Default: []

Список папок.

Response samples

Content type

application/json

{"folders": [ ]
}

Получение ключа папки

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на получение ключа папки по пути от корня виртуальной файловой системы. Если любой папки в пути не существует - вернется 404.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

Название папки.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ последней папки.

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Создание папок (пачка)

Создание новых папок (пачка).

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание группы папок от корня виртуальной файловой системы. Если любая папка в пути уже существует - она не будет создаваться заново. Метод возвращает ключ последней папки даже в случае, если не было создано ни одной папки.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

Название папки.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ последней папки.

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Удаление папок (пачка)

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Получение ключа файла

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на получение ключа файла по пути от корня виртуальной файловой системы. Если в папке несколько файлов с одинаковым названием - возвращается последний измененный. Если любой папки или файла в пути не существует - вернется 404.

folder_names required	Array of strings (folder_name_list) [ 0 .. 10 ] items [ items [ 1 .. 100 ] characters ] Example: ["folder_1"] Список названий папок от корня виртуальной файловой системы.
file_name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ файла.

Request samples

Payload

Content type

application/json

{"folder_names": [ ],
"file_name": "file_1"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Удаление файлов (пачка)

Массовое удаление файлов.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Счетчики файловой системы

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

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

required	object (folder_counters) Текущее количество доступных папок/файлов.
required	object (folder_counters) Максимальное количество доступных папок/файлов.

Response samples

Content type

application/json

{"current": {"folders_count": 12,
"files_count": 16
},
"max": {"folders_count": 12,
"files_count": 16
}
}

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Импорт папки

Импорт папки с экспериментами. Папка не должна типа 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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Experiments

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

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_experiment_column_type) Default: "CREATION_DATE" Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more Example: sort_field=EDIT_DATE Название колонки в таблице с экспериментами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

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

Response samples

Content type

application/json

{"$ref": "experiment_list.json"
}

Список экспериментов (таблица)

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

Authorizations:

ApiKeyAuth

query Parameters

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

Responses

Response Schema: application/json

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

Response samples

Content type

application/json

{"$ref": "experiment_list.json"
}

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

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters 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": "file_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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

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

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

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 (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters 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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

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

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters 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": "file_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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Request samples

Payload

Content type

application/json

{"$ref": "experiment_settings.json"
}

Response samples

Content type

application/json

{"$ref": "experiment.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 .. 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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-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

{"$ref": "experiment.json"
}

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

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

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) Default: "CREATION_DATE" Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more Example: sort_field=EDIT_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> Example: "11111111-2222-3333-4444-555555555555" Ключ предыдущего эксперимента в той же папке.
next_experiment_key	string or null <uuid> 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

required

Array of objects (folder) [ 0 .. 1000 ] items

Default: []

Список папок.

Response samples

Content type

application/json

{"folders": [ ]
}

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

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

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: "2026-01-21T09:30:00+03:00" Дата и время получения статистики в соответствии с ISO 8601.
required	object (general_statistics) Суммарная статистика по одному или совокупности рейсов.

Response samples

Content type

application/json

[ ]

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

Responses

Response samples

Content type

application/json

{"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": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

query Parameters

remove_locations

boolean

Default: false

Example: remove_locations=true

Флаг, отвечающий за удаление локации при очистке данных. Если указан true - удаляются локации, на которые не ссылается ни одна сущность в датасете.

Responses

Response Schema: application/json

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

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

Перерасчет треков

Запуск перерасчета треков 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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

Перерасчет статистики

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

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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

Импорт (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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

Импорт (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 Список фактов. Факт - это произошедшее событие, которое влияет на дальнейшие выполнение рейсов.
	plan_statistics (object) or nullable (null) Default: null Общая статистика по результату расчета.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique Список матриц времен и расстояний для каждого типа транспорта, которые указаны в данных. Матрица должна описывать все локации для каждого типа транспорта из данных. При указании внешней матрицы маршрутизации `external_routing` не учитываются параметры `plan_settings.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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Request samples

Payload

Content type

application/json

{"$ref": "../../universal/examples/convert_task_moscow.json"
}

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

Импорт по 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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Response samples

Content type

application/json

{"$ref": "experiment.json"
}

Импорт по 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 (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
progress	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
pristine required	boolean (basic_pristine) Example: "false" Флаг, показывающий производились ли изменения сущности относительно исходных данных. `true` - означает что данные исходные и не изменялись.
sharing	boolean (basic_sharing) Example: "true" Флаг совместного использования эксперимента.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-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

{"$ref": "experiment.json"
}

Экспорт (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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Экспорт (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 Список фактов. Факт - это произошедшее событие, которое влияет на дальнейшие выполнение рейсов.
	plan_statistics (object) or nullable (null) Default: null Общая статистика по результату расчета.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique Список матриц времен и расстояний для каждого типа транспорта, которые указаны в данных. Матрица должна описывать все локации для каждого типа транспорта из данных. При указании внешней матрицы маршрутизации `external_routing` не учитываются параметры `plan_settings.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

{"$ref": "../../universal/examples/convert_task_moscow.json"
}

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "web_location.json"
}

Response samples

Content type

application/json

{"$ref": "web_location.json"
}

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

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

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "web_location.json"
}

Response samples

Content type

application/json

{"$ref": "web_location.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

Responses

Response Schema: application/json

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

Response samples

Content type

application/json

{"$ref": "web_location.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters 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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_location_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 4 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с локациями.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
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 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.json"
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

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

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

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

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

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_location_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_location_fields) Суммарные значения для полей типов int, double, duration.
	object (table_location_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"fields_sum": {"essence_type": "LOCATION",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"working_time": null,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"essence_type": "LOCATION",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"working_time": null,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"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

{"$ref": "web_order.json"
}

Response samples

Content type

application/json

{"$ref": "web_order.json"
}

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

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

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

{"$ref": "web_order.json"
}

Response samples

Content type

application/json

{"$ref": "web_order.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

{"$ref": "web_order.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters 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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_order_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 30 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с заказами.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
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 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.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 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

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

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

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

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

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_order_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_order_fields) Суммарные значения для полей типов int, double, duration.
	object (table_order_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"fields_sum": {"essence_type": "ORDER",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"state": "PLANNED",
"type": "AAA",
"hard_time_window": null,
"soft_time_window": null,
"general_drop_time_window": null,
"general_pickup_time_window": null,
"general_work_time_window": null,
"reward": 2343.3,
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"order_features": "AAA",
"order_restrictions": "AAA",
"performer_restrictions": "AAA",
"performer_blacklist": "AAA",
"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": "AAA",
"box_restrictions": "AAA",
"cargo_features": "AAA",
"cargo_restrictions": "AAA",
"demands_count": 1,
"trip_key": "key01",
"trip_name": "X1-ABC",
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"essence_type": "ORDER",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"state": "PLANNED",
"type": "AAA",
"hard_time_window": null,
"soft_time_window": null,
"general_drop_time_window": null,
"general_pickup_time_window": null,
"general_work_time_window": null,
"reward": 2343.3,
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"order_features": "AAA",
"order_restrictions": "AAA",
"performer_restrictions": "AAA",
"performer_blacklist": "AAA",
"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": "AAA",
"box_restrictions": "AAA",
"cargo_features": "AAA",
"cargo_restrictions": "AAA",
"demands_count": 1,
"trip_key": "key01",
"trip_name": "X1-ABC",
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"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

{"$ref": "web_performer.json"
}

Response samples

Content type

application/json

{"$ref": "web_performer.json"
}

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

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

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

{"$ref": "web_performer.json"
}

Response samples

Content type

application/json

{"$ref": "web_performer.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

{"$ref": "web_performer.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters 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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_performer_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 12 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с исполнителями.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
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 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.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 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

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

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

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

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

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_performer_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_performer_fields) Суммарные значения для полей типов int, double, duration.
	object (table_performer_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"fields_sum": {"essence_type": "PERFORMER",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"working_time": null,
"availability_time": null,
"trip_key": "key01",
"trip_name": "X1-ABC",
"location_keys": "AAA",
"performer_features": "AAA",
"transport_restrictions": "AAA",
"trips_count": 1,
"shifts_count": 1,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"essence_type": "PERFORMER",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"working_time": null,
"availability_time": null,
"trip_key": "key01",
"trip_name": "X1-ABC",
"location_keys": "AAA",
"performer_features": "AAA",
"transport_restrictions": "AAA",
"trips_count": 1,
"shifts_count": 1,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"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

{"$ref": "web_transport.json"
}

Response samples

Content type

application/json

{"$ref": "web_transport.json"
}

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

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

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

{"$ref": "web_transport.json"
}

Response samples

Content type

application/json

{"$ref": "web_transport.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

{"$ref": "web_transport.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters 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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_transport_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 17 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с транспортом.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
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 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.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 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

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

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

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

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

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_transport_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_transport_fields) Суммарные значения для полей типов int, double, duration.
	object (table_transport_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"fields_sum": {"essence_type": "TRANSPORT",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"availability_time": null,
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "X1-ABC",
"location_keys": "AAA",
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"transport_features": "AAA",
"performer_restrictions": "AAA",
"trips_count": 1,
"shifts_count": 1,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"essence_type": "TRANSPORT",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"availability_time": null,
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "X1-ABC",
"location_keys": "AAA",
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"transport_features": "AAA",
"performer_restrictions": "AAA",
"trips_count": 1,
"shifts_count": 1,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"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

{"$ref": "web_hardlink.json"
}

Response samples

Content type

application/json

{"$ref": "web_hardlink.json"
}

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

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

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

{"$ref": "web_hardlink.json"
}

Response samples

Content type

application/json

{"$ref": "web_hardlink.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

{"$ref": "web_hardlink.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters 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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_hardlink_column_type) Default: "ESSENCE_KEY" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 5 more Example: sort_field=ELEMENTS_COUNT Название колонки в таблице со связями.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
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 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.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 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Метрики по назначениям

Расчет общих метрик по выбранным назначениям.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_hardlink_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_hardlink_fields) Суммарные значения для полей типов int, double, duration.
	object (table_hardlink_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"fields_sum": {"essence_type": "HARDLINK",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"element_type": "ORDER,PERFORMER_SHIFT",
"elements_count": 1,
"trip_key": "key01",
"trip_name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"essence_type": "HARDLINK",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"element_type": "ORDER,PERFORMER_SHIFT",
"elements_count": 1,
"trip_key": "key01",
"trip_name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

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

{"$ref": "web_trip.json"
}

Response samples

Content type

application/json

{"$ref": "web_trip.json"
}

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

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

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

{"$ref": "web_trip.json"
}

Response samples

Content type

application/json

{"$ref": "web_trip.json"
}

Чтение рейса

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

Authorizations:

ApiKeyAuth

path Parameters

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

{"$ref": "web_trip.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters 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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_trip_column_type) Default: "TRIP_NAME" Enum: "ESSENCE_KEY" "ENABLED" "TRIP_VERIFIED" … 32 more Example: sort_field=DISTANCE Название колонки в таблице с рейсами.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
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 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.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 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Пути рейсов

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

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
tracks_type required	string (track_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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

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

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

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "track_list.json"
}

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

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

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 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_trip_column_type) Default: "TRIP_NAME" Enum: "ESSENCE_KEY" "ENABLED" "TRIP_VERIFIED" … 32 more Example: sort_field=DISTANCE Название колонки в таблице с рейсами.
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 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_chart_list.json"
}

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

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

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

Default: []

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

Responses

Request samples

Payload

Content type

application/json

{"$ref": "track_list_custom.json"
}

Response samples

Content type

application/json

{"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": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Метрики по заказам

Расчет общих метрик по выбранным заказам.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_trip_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_trip_fields) Суммарные значения для полей типов int, double, duration.
	object (table_trip_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"fields_sum": {"essence_type": "ROUNDTRIP",
"essence_key": "key01",
"enabled": false,
"trip_verified": true,
"pristine": false,
"trip_name": "X1-ABC",
"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": null,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1,
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"essence_type": "ROUNDTRIP",
"essence_key": "key01",
"enabled": false,
"trip_verified": true,
"pristine": false,
"trip_name": "X1-ABC",
"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": null,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1,
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_trip_stop_column_type) Default: "ESSENCE_KEY" Enum: "ESSENCE_KEY" "DRIVING_TIME" "WAITING_TIME" … 14 more Example: sort_field=LOCATION_NAME Название колонки в таблице с остановками рейса.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
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 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.json"
}

Утверждение рейсов (пачка)

Массовое утверждение рейсов. Устанавливает зарезервированный атрибут TRIP_VERIFIED = true для каждого рейса.

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 (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Отклонение рейсов (пачка)

Массовое отклонение рейсов. Устанавливает зарезервированный атрибут TRIP_VERIFIED = 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 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

{"$ref": "web_fact.json"
}

Response samples

Content type

application/json

{"$ref": "web_fact.json"
}

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

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

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

{"$ref": "web_fact.json"
}

Response samples

Content type

application/json

{"$ref": "web_fact.json"
}

Чтение факта

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

Authorizations:

ApiKeyAuth

path Parameters

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

{"$ref": "web_fact.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters 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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 .. 2001 ] 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 (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
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 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

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

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.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 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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 (basic_essence_key) [ 1 .. 1024 ] characters

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Метрики по фактам

Расчет общих метрик по выбранным фактам.

Authorizations:

ApiKeyAuth

path Parameters

experiment_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_fact_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_fact_fields) Суммарные значения для полей типов int, double, duration.
	object (table_fact_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"fields_sum": {"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_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"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_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

User

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

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

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Новый ключ.

string (settings_key) [ 1 .. 1024 ] characters

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

Responses

Response Schema: application/json

settings_keys required	Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Default: [] Example: ["path-key-01"] Список ключей настроек.
active_key	string or null (settings_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": [ ],
"active_key": "path-key-01"
}

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

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

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

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

Response samples

Content type

application/json

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

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

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

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_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 (settings_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 (settings_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 (settings_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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

CustomFields

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

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

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

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

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

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Новый ключ.

string (settings_key) [ 1 .. 1024 ] characters

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

Responses

Response Schema: application/json

settings_keys required	Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Default: [] Example: ["path-key-01"] Список ключей настроек.
active_key	string or null (settings_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": [ ],
"active_key": "path-key-01"
}

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

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

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

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

Response samples

Content type

application/json

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

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

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

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_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

Default: []

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

Responses

Response Schema: application/json

required

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

Default: []

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

Request samples

Payload

Content type

application/json

{"$ref": "customfields.json"
}

Response samples

Content type

application/json

{"$ref": "customfields.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

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

Responses

Response Schema: application/json

required

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

Default: []

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

Response samples

Content type

application/json

{"$ref": "customfields.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_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

Default: []

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

Responses

Response Schema: application/json

required

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

Default: []

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

Request samples

Payload

Content type

application/json

{"$ref": "customfields.json"
}

Response samples

Content type

application/json

{"$ref": "customfields.json"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

CustomIcons

Настройки иконок.

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

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Новый ключ.

string (settings_key) [ 1 .. 1024 ] characters

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

Responses

Response Schema: application/json

settings_keys required	Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Default: [] Example: ["path-key-01"] Список ключей настроек.
active_key	string or null (settings_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": [ ],
"active_key": "path-key-01"
}

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

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

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

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

Response samples

Content type

application/json

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

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

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

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

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

Request Body schema: application/octet-stream
required

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

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

Request Body schema: application/octet-stream
required

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

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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_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": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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_one",
"detail": null
}

VRt.Studio [ST] (7.26.3024)

Описание

Зарезервированные атрибуты

Роли

ADMIN, PARTNER, USER, BOT

COMPANYOWNER

OVERLORD

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

Explorer

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

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

Authorizations:

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:

path Parameters

Responses

Response Schema: application/json

Response samples

Получение ключа папки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Создание папок (пачка)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Удаление папок (пачка)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Получение ключа файла

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Удаление файлов (пачка)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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