VRt.Monitor [MT] (7.25.3009)

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

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

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

Описание

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

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

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

Crews

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

Экипаж состоит из:

Мобильное устройство
Исполнитель
Транспортное средство

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

Создание нового экипажа.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
password	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Пароль.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: "null" Описание исполнителя.
	transport (object) or nullable (null) Default: "null" Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Responses

Response Schema: application/json

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: "null" Описание исполнителя.
	transport (object) or nullable (null) Default: "null" Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Request samples

Payload

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"password": "long_strong_password",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Response samples

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

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

Обновление информации об экипаже.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
password	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Пароль.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: "null" Описание исполнителя.
	transport (object) or nullable (null) Default: "null" Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Responses

Response Schema: application/json

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: "null" Описание исполнителя.
	transport (object) or nullable (null) Default: "null" Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Request samples

Payload

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"password": "long_strong_password",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Response samples

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Чтение экипажа

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

Authorizations:

ApiKeyAuth

path Parameters

crew_key

required

string (crew_key) [ 3 .. 256 ] characters \w+

Example: mega_crew

Параметр (path) с ключом экипажа.

Responses

Response Schema: application/json

required	object (crew) Экипаж.
	object (table_crew_fields) Табличные поля экипажей.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"crew": {"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
},
"fields": {"essence_type": "CREW",
"essence_key": "key01",
"username": "AAA",
"company_key": "key01",
"device_phone": "AAA",
"device_online": true
},
"linked_essences": [ ]
}

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

Удаление экипажа.

Authorizations:

ApiKeyAuth

path Parameters

crew_key

required

string (crew_key) [ 3 .. 256 ] characters \w+

Example: mega_crew

Параметр (path) с ключом экипажа.

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

Чтение экипажей (таблица)

Получение списка экипажей в виде таблицы.

Authorizations:

ApiKeyAuth

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_crew_column_type) Default: "USERNAME" Enum: "ESSENCE_KEY" "USERNAME" "COMPANY_KEY" … 2 more Example: sort_field=DEVICE_ONLINE Название колонки в таблице с экипажами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр экипажей.

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

Default: []

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

Responses

Response Schema: application/json

required	Array of objects (table_crew) [ 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

{"essences": [ ],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Удаление экипажей (пачка)

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на удаление экипажа.

Array ([ 0 .. 2001 ] items)

string (crew_key) [ 3 .. 256 ] characters \w+

Уникальный идентификатор экипажа.

Responses

Request samples

Payload

Content type

application/json

["mega_crew"
]

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

Геоточки экипажей

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

Authorizations:

ApiKeyAuth

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_crew_filter) [ 0 .. 50 ] items

Default: []

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

Responses

Response Schema: application/json

required	Array of objects (crew_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
}
}

Свой экипаж APP

Получение информации о своем экипаже (по логину).

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: "null" Описание исполнителя.
	transport (object) or nullable (null) Default: "null" Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Response samples

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Свои рейсы APP

Получение списка рейсов, назначенных на экипаж (по логину).

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

Array ([ 0 .. 10 ] items)

required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
required	object (trip_statistics) Статистика по конкретному рейсу.
	object (table_trip_fields) Табличные поля рейса и остановок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.
status	string (trip_status) Enum: "FREE" "ASSIGNED" "SENT" … 4 more Example: "FINISHED" Текущее состояние рейса: `FREE` - рейс не имеет экипажа `ASSIGNED` - на рейс назначен экипаж `SENT` - рейс отправлен экипажу на согласование `CONFIRMED` - рейс подтвержден экипажем `REJECTED` - рейс отклонен экипажем `IN_PROGRESS` - рейс в процессе выполнения `FINISHED` - рейс завершен
crew_key	string or null (crew_key_null) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа (nullable).

Response samples

Content type

application/json

[{"trip": {"key": "trip-0000-9999",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
}
},
"states": [{"time": "2025-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"name": "X1-ABC",
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 5.5,
"volume": 4.1,
"capacity_a": 3.7,
"capacity_b": 2.8,
"capacity_c": 2.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"average_roundtrip_distance": 23.4,
"average_roundtrip_time": "PT1H45M",
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [ ],
"roundtrip_statistics": [ ],
"attributes": [ ]
},
"fields": {"essence_type": "TRIP",
"essence_key": "key01",
"trip_name": "X1-ABC",
"crew_key": "mega_crew",
"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": "2025-11-21T18:00:00+03:00",
"datetime_1": "2025-11-21T18:00:00+03:00",
"datetime_2": "2025-11-21T18:00:00+03:00",
"datetime_3": "2025-11-21T18:00:00+03:00",
"datetime_4": "2025-11-21T18:00:00+03:00",
"datetime_5": "2025-11-21T18:00:00+03:00",
"datetime_6": "2025-11-21T18:00:00+03:00",
"datetime_7": "2025-11-21T18:00:00+03:00",
"datetime_8": "2025-11-21T18:00:00+03:00",
"datetime_9": "2025-11-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"
}
},
"linked_essences": [ ],
"status": "FINISHED",
"crew_key": "mega_crew"
}
]

Deals

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

Сделка - назначение экипажа на конкретный рейс из конкретной волны.

Объект временный, автоматически удаляется после завершения рейса экипажем.

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

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

crew_key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
wave_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
trip_key required	string [ 1 .. 1024 ] characters Example: "trip-0000-9999" Уникальный идентификатор рейса.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Уникальный идентификатор сделки.
required	object (deal_specification) Описание сделки.

Request samples

Payload

Content type

application/json

{"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

Обновление сделки

Обновление информации о сделке.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Уникальный идентификатор сделки.
required	object (deal_specification) Описание сделки.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Уникальный идентификатор сделки.
required	object (deal_specification) Описание сделки.

Request samples

Payload

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

Чтение сделки

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

Authorizations:

ApiKeyAuth

path Parameters

deal_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 (deal_specification) Описание сделки.

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

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

Удаление сделки.

Authorizations:

ApiKeyAuth

path Parameters

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

Waves

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

Волна состоит из:

Исходные данные для расчета (заказы, исполнители, транспорт, настройки)
Результаты расчета (рейсы, статистика)
Результаты выполнения (факты)

Создание волны

Создание нового волны.

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

wave_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) Статистика эксперимента.
	calculation_state (object) or nullable (null) Default: "null" Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: "null" Результат проверки загруженных данных.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Response samples

Content type

application/json

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

Обновление волны

Переименование \ перемещение волны.

Authorizations:

ApiKeyAuth

path Parameters

wave_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) Статистика эксперимента.
	calculation_state (object) or nullable (null) Default: "null" Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: "null" Результат проверки загруженных данных.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-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": "wave.json"
}

Удаление волны

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

Authorizations:

ApiKeyAuth

path Parameters

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

Список волн (таблица)

Получение списка волн в виде таблицы.

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_wave_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more Example: sort_field=SPECIFICATION_FOLDER_KEY Название колонки в таблице с волнами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

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

Response samples

Content type

application/json

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

Поиск волн

Глобальный поиск волн по всем вложенным папкам.

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_wave_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more Example: sort_field=SPECIFICATION_FOLDER_KEY Название колонки в таблице с волнами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

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

Response samples

Content type

application/json

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

Дублирование волны

Дублирование волны.

Authorizations:

ApiKeyAuth

path Parameters

wave_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

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

Импорт (XLSX)

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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) Статистика эксперимента.
	calculation_state (object) or nullable (null) Default: "null" Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: "null" Результат проверки загруженных данных.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Response samples

Content type

application/json

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

Импорт (JSON)

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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) Статистика эксперимента.
	calculation_state (object) or nullable (null) Default: "null" Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: "null" Результат проверки загруженных данных.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-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": "wave.json"
}

Экспорт (XLSX)

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

Authorizations:

ApiKeyAuth

path Parameters

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

Экспорт (JSON)

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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

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

Orders

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

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

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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

wave_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

wave_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

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

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

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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

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

Performers

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

Transports

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

Hardlinks

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

Trips

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

Чтение рейса

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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 Список связанных сущностей.
status	string (trip_status) Enum: "FREE" "ASSIGNED" "SENT" … 4 more Example: "FINISHED" Текущее состояние рейса: `FREE` - рейс не имеет экипажа `ASSIGNED` - на рейс назначен экипаж `SENT` - рейс отправлен экипажу на согласование `CONFIRMED` - рейс подтвержден экипажем `REJECTED` - рейс отклонен экипажем `IN_PROGRESS` - рейс в процессе выполнения `FINISHED` - рейс завершен
crew_key	string or null (crew_key_null) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа (nullable).

Response samples

Content type

application/json

{"trip": {"key": "trip-0000-9999",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
}
},
"states": [{"time": "2025-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"name": "X1-ABC",
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 5.5,
"volume": 4.1,
"capacity_a": 3.7,
"capacity_b": 2.8,
"capacity_c": 2.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"average_roundtrip_distance": 23.4,
"average_roundtrip_time": "PT1H45M",
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [ ],
"roundtrip_statistics": [ ],
"attributes": [ ]
},
"fields": {"essence_type": "TRIP",
"essence_key": "key01",
"trip_name": "X1-ABC",
"crew_key": "mega_crew",
"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": "2025-11-21T18:00:00+03:00",
"datetime_1": "2025-11-21T18:00:00+03:00",
"datetime_2": "2025-11-21T18:00:00+03:00",
"datetime_3": "2025-11-21T18:00:00+03:00",
"datetime_4": "2025-11-21T18:00:00+03:00",
"datetime_5": "2025-11-21T18:00:00+03:00",
"datetime_6": "2025-11-21T18:00:00+03:00",
"datetime_7": "2025-11-21T18:00:00+03:00",
"datetime_8": "2025-11-21T18:00:00+03:00",
"datetime_9": "2025-11-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"
}
},
"linked_essences": [ ],
"status": "FINISHED",
"crew_key": "mega_crew"
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

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

Чтение рейсов (таблица)

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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" "TRIP_NAME" "CREW_KEY" … 30 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

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

Пути рейсов

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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

wave_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_crew_column_type) Default: "USERNAME" Enum: "ESSENCE_KEY" "USERNAME" "COMPANY_KEY" … 2 more Example: sort_field=DEVICE_ONLINE Название колонки в таблице с экипажами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр экипажей.

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

Default: []

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

Responses

Response Schema: application/json

required	Array of objects (table_crew) [ 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

{"essences": [ ],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Запуск рейсов (пачка)

Запуск рейсов (пачка). Если список ключей рейсов пустой - запускаются все рейсы из волны.

Authorizations:

ApiKeyAuth

path Parameters

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

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

Остановка рейсов (пачка). Если список ключей рейсов пустой - останавливаются все рейсы из волны.

Authorizations:

ApiKeyAuth

path Parameters

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

Facts

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

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

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

Authorizations:

ApiKeyAuth

path Parameters

wave_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

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

key required	string [ 1 .. 1024 ] characters Example: "fact_01" Ключ факта.
time required	string <date-time> (fact_time) Example: "2025-11-21T09:30:00+03:00" Дата и время создания факта в формате ISO 8601.
type required	string (fact_type) Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 1 more Example: "NEW_LOCATION" Возможные типы фактов: `NEW_LOCATION` - исполнитель изменил свое местоположение в процессе выполнения рейса `ORDER_DONE` - исполнитель закончил выполнять заказ (или заказ был отменен), связанный с заказом груз более не находится в отсеках транспорта `DEMAND_START` - исполнитель начал выполнять заявку `DEMAND_DONE` - исполнитель закончил выполнять заявку
trip_key required	string [ 1 .. 1024 ] characters Example: "trip_01" Ключ рейса, к которому относится факт.
order_key	string or null [ 1 .. 1024 ] characters Default: "null" Example: "order_01" Ключ заказа, обязателен для фактов с типом `ORDER_DONE`.
demand_key	string or null [ 1 .. 1024 ] characters Default: "null" Example: "order_01_demand_01" Ключ заявки, обязателен для фактов с типами `DEMAND_DONE` и `DEMAND_START`.
performer_key	string or null [ 1 .. 1024 ] characters Default: "null" Example: "performer_01" Ключ исполнителя, обязателен для фактов с типом `NEW_LOCATION`.
location_key	string or null [ 1 .. 1024 ] characters Default: "null" Example: "location_01" Ключ локации, обязателен для фактов с типом `NEW_LOCATION`.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

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": "fact_new_location.json"
}

Response samples

Content type

application/json

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

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

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

Authorizations:

ApiKeyAuth

path Parameters

wave_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

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

key required	string [ 1 .. 1024 ] characters Example: "fact_01" Ключ факта.
time required	string <date-time> (fact_time) Example: "2025-11-21T09:30:00+03:00" Дата и время создания факта в формате ISO 8601.
type required	string (fact_type) Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 1 more Example: "NEW_LOCATION" Возможные типы фактов: `NEW_LOCATION` - исполнитель изменил свое местоположение в процессе выполнения рейса `ORDER_DONE` - исполнитель закончил выполнять заказ (или заказ был отменен), связанный с заказом груз более не находится в отсеках транспорта `DEMAND_START` - исполнитель начал выполнять заявку `DEMAND_DONE` - исполнитель закончил выполнять заявку
trip_key required	string [ 1 .. 1024 ] characters Example: "trip_01" Ключ рейса, к которому относится факт.
order_key	string or null [ 1 .. 1024 ] characters Default: "null" Example: "order_01" Ключ заказа, обязателен для фактов с типом `ORDER_DONE`.
demand_key	string or null [ 1 .. 1024 ] characters Default: "null" Example: "order_01_demand_01" Ключ заявки, обязателен для фактов с типами `DEMAND_DONE` и `DEMAND_START`.
performer_key	string or null [ 1 .. 1024 ] characters Default: "null" Example: "performer_01" Ключ исполнителя, обязателен для фактов с типом `NEW_LOCATION`.
location_key	string or null [ 1 .. 1024 ] characters Default: "null" Example: "location_01" Ключ локации, обязателен для фактов с типом `NEW_LOCATION`.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

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": "fact_new_location.json"
}

Response samples

Content type

application/json

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

Чтение факта

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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

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

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

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

Authorizations:

ApiKeyAuth

path Parameters

wave_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

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

Analytics

Аналитика и прогноз.

Reports

Отчетность.

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": "2025-11-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": "2025-11-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": "2025-11-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": "2025-11-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": "2025-11-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": "2025-11-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.Monitor [MT] (7.25.3009)

Описание

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

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

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

Authorizations:

Responses

Response Schema: application/json

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
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional