VRt.Monitor [MT] (7.19.2779)

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

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

Описание

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

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

erd

Explorer

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

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

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

parent_key
string or null <uuid> (unique_key_null)
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"

Цвет папки.

Array of objects (attributes) [ 0 .. 250 ] items unique

Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json
string <uuid> (unique_key)

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

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

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

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

Authorizations:
ApiKeyAuth
query Parameters
folder_key
string or null <uuid> (unique_key_null)
Default: null
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" … 3 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

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

required
object (table_list_counters)

Счетчики по списку.

Response samples

Content type
application/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> (unique_key_null)
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"

Цвет папки.

Array of objects (attributes) [ 0 .. 250 ] items unique

Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json
required
object (folder)

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

required
Array of objects (folder) [ 0 .. 2001 ] items

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

required
object (table_list_counters)

Счетчики по списку.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/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
{
}

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

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

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> (unique_key_null)
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"

Цвет папки.

Array of objects (attributes) [ 0 .. 250 ] items unique

Атрибуты. Используются для указания служебной информации.

Response samples

Content type
application/json
{
}

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

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

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

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

Response samples

Content type
application/json
{
}

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

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

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

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

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

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

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

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

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

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

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
required
object (folder_counters)

Текущее количество доступных папок/файлов.

required
object (folder_counters)

Максимальное количество доступных папок/файлов.

Response samples

Content type
application/json
{
}

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

Импорт папки

Импорт папки с экспериментами. Папка не должна типа 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
{
}

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"

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

required
object (performer)

Исполнитель. Выполняет заказы, используя транспорт.

required
object (transport)

Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.

object (device)

Мобильное устройство.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Описание экипажа.

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"

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

required
object (performer)

Исполнитель. Выполняет заказы, используя транспорт.

required
object (transport)

Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.

object (device)

Мобильное устройство.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Описание экипажа.

Array of objects (deal_list) [ 0 .. 30 ] items

Связанные с экипажем текущие сделки.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

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

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

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"

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

required
object (performer)

Исполнитель. Выполняет заказы, используя транспорт.

required
object (transport)

Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.

object (device)

Мобильное устройство.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Описание экипажа.

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"

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

required
object (performer)

Исполнитель. Выполняет заказы, используя транспорт.

required
object (transport)

Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.

object (device)

Мобильное устройство.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Описание экипажа.

Array of objects (deal_list) [ 0 .. 30 ] items

Связанные с экипажем текущие сделки.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

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

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

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

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

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

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

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

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

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

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

Responses

Response Schema: application/json
required
Array of objects (table_crew) [ 0 .. 2001 ] items

Список.

required
object (table_list_counters)

Счетчики по списку.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

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

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

Array ([ 0 .. 2001 ] items)
string (crew_key) [ 3 .. 256 ] characters \w+

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

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

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

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

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

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

Responses

Response Schema: application/json
required
Array of objects (crew_geopoint) [ 0 .. 2001 ] items

Список точек.

required
object (table_list_counters)

Счетчики по списку сущностей.

required
object (table_list_counters_detail)

Счетчики по списку точек.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Свой экипаж

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

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"

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

required
object (performer)

Исполнитель. Выполняет заказы, используя транспорт.

required
object (transport)

Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.

object (device)

Мобильное устройство.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Описание экипажа.

Array of objects (deal_list) [ 0 .. 30 ] items

Связанные с экипажем текущие сделки.

Response samples

Content type
application/json
{
}

Свои рейсы

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

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

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

Response samples

Content type
application/json
[
]

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

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

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

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

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

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

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

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

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

Authorizations:
ApiKeyAuth
path Parameters
deal_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response samples

Content type
application/json
{
}

Waves

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

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

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

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

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

name
required
string [ 1 .. 100 ] characters
Example: "wave_1"

Название волны.

comment
required
string or null [ 0 .. 10000 ] characters
Default: null
Example: "long long long long text"

Комментарий к волне.

folder_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Ключ папки типа FOLDER, в которой находится волна

Responses

Response Schema: application/json
string <uuid> (unique_key)

Ключ созданной волны.

Request samples

Content type
application/json
{
}

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 (wave_specification)

Описание волны.

required
object (experiment_settings)

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

required
object (experiment_statistics)

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

object or null (calculation_state)

Текущее состояние расчета.

object or null (experiment_check)

Результат проверки данных по файлу.

edit_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Дата и время создания в соответствии с ISO 8601.

Response samples

Content type
application/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 [ 1 .. 100 ] characters
Example: "wave_1"

Название волны.

comment
required
string or null [ 0 .. 10000 ] characters
Default: null
Example: "long long long long text"

Комментарий к волне.

folder_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Ключ папки типа FOLDER, в которой находится волна

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

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

required
object (wave_specification)

Описание волны.

required
object (experiment_settings)

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

required
object (experiment_statistics)

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

object or null (calculation_state)

Текущее состояние расчета.

object or null (experiment_check)

Результат проверки данных по файлу.

edit_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Дата и время создания в соответствии с ISO 8601.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/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
{
}

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

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

Authorizations:
ApiKeyAuth
query Parameters
folder_key
string or null <uuid> (unique_key_null)
Default: null
Example: folder_key=11111111-2222-3333-4444-555555555555

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

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" "SPECIFICATION_NAME" "SPECIFICATION_COMMENT" … 1 more
Example: sort_field=SPECIFICATION_FOLDER_KEY

Название колонки в таблице с волнами.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Направление сортировки.

Request Body schema: application/json
optional

Фильтр волн.

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

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

Responses

Response Schema: application/json
required
Array of objects (table_wave) [ 0 .. 2001 ] items

Список.

required
object (table_list_counters)

Счетчики по списку.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

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

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

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

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/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 [ 1 .. 100 ] characters
Example: "wave_1"

Название волны.

comment
required
string or null [ 0 .. 10000 ] characters
Default: null
Example: "long long long long text"

Комментарий к волне.

folder_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Ключ папки типа FOLDER, в которой находится волна

Responses

Response Schema: application/json
string <uuid> (unique_key)

Ключ продублированного волны.

Request samples

Content type
application/json
{
}

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

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

Response samples

Content type
application/json
{
}

Импорт (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 (wave_specification)

Описание волны.

required
object (experiment_settings)

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

required
object (experiment_statistics)

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

object or null (calculation_state)

Текущее состояние расчета.

object or null (experiment_check)

Результат проверки данных по файлу.

edit_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Дата и время создания в соответствии с ISO 8601.

Response samples

Content type
application/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

Список фактов. Факт - это произошедшее событие, которое влияет на дальнейшие выполнение рейсов.

object or null (plan_statistics)

Общая статистика по результату расчета.

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 (wave_specification)

Описание волны.

required
object (experiment_settings)

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

required
object (experiment_statistics)

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

object or null (calculation_state)

Текущее состояние расчета.

object or null (experiment_check)

Результат проверки данных по файлу.

edit_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Дата и время создания в соответствии с ISO 8601.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/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
{
}

Экспорт (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

Список фактов. Факт - это произошедшее событие, которое влияет на дальнейшие выполнение рейсов.

object or null (plan_statistics)

Общая статистика по результату расчета.

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

Locations

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

Orders

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

Performers

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

Transports

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

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

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

Response samples

Content type
application/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
{
}

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

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

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 or null (table_customfields_column_type)
Default: null
Enum: "DATETIME_1" "DATETIME_2" "DATETIME_3" … 27 more
Example: sort_customfield=NONE

Название дополнительной колонки в таблице.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Направление сортировки.

Request Body schema: application/json
optional

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

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

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

Responses

Response Schema: application/json
required
Array of objects (table_trip) [ 0 .. 2001 ] items

Список.

required
object (table_list_counters)

Счетчики по списку.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/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

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Пути рейсов

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

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

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

Responses

Response Schema: application/json
required
Array of objects (track) [ 0 .. 2001 ] items

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

required
object (table_list_counters)

Счетчики по списку.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/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

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

Responses

Response Schema: application/json
required
Array of objects (table_crew) [ 0 .. 2001 ] items

Список.

required
object (table_list_counters)

Счетчики по списку.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/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

Content type
application/json
[
]

Response samples

Content type
application/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

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

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

Content type
application/json
{
}

Response samples

Content type
application/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-09-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

Content type
application/json
{
}

Response samples

Content type
application/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
{
}

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

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

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

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

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

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 or null (table_customfields_column_type)
Default: null
Enum: "DATETIME_1" "DATETIME_2" "DATETIME_3" … 27 more
Example: sort_customfield=NONE

Название дополнительной колонки в таблице.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Направление сортировки.

Request Body schema: application/json
optional

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

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

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

Responses

Response Schema: application/json
required
Array of objects (table_fact) [ 0 .. 2001 ] items

Список связей.

required
object (table_list_counters)

Счетчики по списку.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/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

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

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 ]
Example: ["path-key-01"]

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

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Ключ текущей активной настройки. Ключ из списка settings_keys или null (если нет активной настройки).

Request samples

Content type
application/json
"path-key-01"

Response samples

Content type
application/json
{
}

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

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

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
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
{
}

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

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

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

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

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

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 ]
Example: ["path-key-01"]

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

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Ключ текущей активной настройки. Ключ из списка settings_keys или null (если нет активной настройки).

Request samples

Content type
application/json
"path-key-01"

Response samples

Content type
application/json
{
}

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

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

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
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
{
}

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

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

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

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

Responses

Response Schema: application/json
required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

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

Request samples

Content type
application/json
{
}

Response samples

Content type
application/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

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

Response samples

Content type
application/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

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

Responses

Response Schema: application/json
required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

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

Request samples

Content type
application/json
{
}

Response samples

Content type
application/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
{
}

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 ]
Example: ["path-key-01"]

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

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Ключ текущей активной настройки. Ключ из списка settings_keys или null (если нет активной настройки).

Request samples

Content type
application/json
"path-key-01"

Response samples

Content type
application/json
{
}

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

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

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
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
{
}

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

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

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

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

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

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

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

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

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

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

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

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

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

Responses

Response samples

Content type
application/json
{
}

System

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

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

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

Responses

Response Schema: application/json
health
required
number <double> [ 0 .. 1 ]
Example: "0.999"

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

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

Response samples

Content type
application/json
{
}

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

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

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

Content type
application/json
{
}

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

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

path Parameters
filename
required
string [ 6 .. 128 ] characters
Example: file_en.html

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

Responses

Response Schema:
string (file_html)

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

Response samples

Content type
application/json
{
}