VRt.Admin
VEEROUTE 2024

VRt.Admin [AD] (6.20.2289)

Veeroute Support Team: servicedesk@veeroute.comLicense: Proprietary Terms of Service
Основной сайт

Описание

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

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

erd

Companies

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

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

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

key
required
string [ 3 .. 256 ] characters \w+

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

detail
string or null [ 0 .. 1024 ] characters
Default: null

Описание компании.

Responses

Request samples

Content type
application/json
{
  • "key": "my_company",
  • "detail": null
}

Response samples

Content type
application/json
{
  • "key": "my_company",
  • "detail": null
}

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

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

key
required
string [ 3 .. 256 ] characters \w+

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

detail
string or null [ 0 .. 1024 ] characters
Default: null

Описание компании.

Responses

Response Schema: application/json
key
required
string [ 3 .. 256 ] characters \w+

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

detail
string or null [ 0 .. 1024 ] characters
Default: null

Описание компании.

Request samples

Content type
application/json
{
  • "key": "my_company",
  • "detail": null
}

Response samples

Content type
application/json
{
  • "key": "my_company",
  • "detail": null
}

Список компаний

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

Authorizations:
ApiKeyAuth
query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

filter
string [ 1 .. 64 ] characters
Example: filter=example text

Фильтр для поиска по текстовым полям.

sort_field
string [ 1 .. 64 ] characters
Example: sort_field=name

Поле, по которому необходимо делать сортировку.

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

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

Responses

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

Список компаний.

required
object (company_list_stats)

Статистика по списку компаний.

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "statistics": {
    }
}

Чтение компании

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

Authorizations:
ApiKeyAuth
path Parameters
key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: my_company

Ключ компании, которая объединяет разных пользователей в одну группу.

Responses

Response Schema: application/json
key
required
string [ 3 .. 256 ] characters \w+

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

detail
string or null [ 0 .. 1024 ] characters
Default: null

Описание компании.

Response samples

Content type
application/json
{
  • "key": "my_company",
  • "detail": null
}

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

Удаление компании.

Authorizations:
ApiKeyAuth
path Parameters
key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: my_company

Ключ компании, которая объединяет разных пользователей в одну группу.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "Bad Request"
}

Users

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

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

Создание нового пользователя.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

username
required
string (user_name) [ 2 .. 256 ] characters \w+

Логин, уникальный идентификатор пользователя.

password
string or null<password> [ 5 .. 256 ] characters
Default: null

Пароль.

name
string or null [ 2 .. 256 ] characters
Default: null

ФИО пользователя.

email
string or null<email> [ 5 .. 256 ] characters
Default: null

Почта пользователя.

phone
string or null [ 5 .. 32 ] characters
Default: null

Телефон пользователя.

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

Ключ компании, которая объединяет разных пользователей в одну группу.

enabled
boolean
Default: true

Статус пользователя.

roles
required
Array of strings (user_roles) [ 0 .. 2 ] items unique
Items Enum: "ADMIN" "PARTNER" "USER" … 1 more

Перечень ролей пользователя.

timezone
integer<int32> [ -12 .. 12 ]
Default: 0

Базовая временная зона, которая используется для расчета статистики.

Responses

Request samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "password": "my_password",
  • "name": "my_visible_name",
  • "email": "admin@company.com",
  • "phone": "+71112223333",
  • "company_key": "my_company",
  • "enabled": true,
  • "roles": [ ],
  • "timezone": 3
}

Response samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "name": "my_visible_name",
  • "email": "admin@company.com",
  • "phone": "+71112223333",
  • "company_key": "my_company",
  • "enabled": true,
  • "roles": [ ],
  • "timezone": 3
}

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

Обновление информации о пользователе по его логину. Поле username изменить нельзя.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

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

username
required
string (user_name) [ 2 .. 256 ] characters \w+

Логин, уникальный идентификатор пользователя.

password
string or null<password> [ 5 .. 256 ] characters
Default: null

Пароль.

name
string or null [ 2 .. 256 ] characters
Default: null

ФИО пользователя.

email
string or null<email> [ 5 .. 256 ] characters
Default: null

Почта пользователя.

phone
string or null [ 5 .. 32 ] characters
Default: null

Телефон пользователя.

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

Ключ компании, которая объединяет разных пользователей в одну группу.

enabled
boolean
Default: true

Статус пользователя.

roles
required
Array of strings (user_roles) [ 0 .. 2 ] items unique
Items Enum: "ADMIN" "PARTNER" "USER" … 1 more

Перечень ролей пользователя.

timezone
integer<int32> [ -12 .. 12 ]
Default: 0

Базовая временная зона, которая используется для расчета статистики.

Responses

Response Schema: application/json
username
required
string (user_name) [ 2 .. 256 ] characters \w+

Логин, уникальный идентификатор пользователя.

name
string or null [ 2 .. 256 ] characters
Default: null

ФИО пользователя.

email
string or null<email> [ 5 .. 256 ] characters
Default: null

Почта пользователя.

phone
string or null [ 5 .. 32 ] characters
Default: null

Телефон пользователя.

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

Ключ компании, которая объединяет разных пользователей в одну группу.

enabled
boolean
Default: true

Статус пользователя.

roles
required
Array of strings (user_roles) [ 0 .. 2 ] items unique
Items Enum: "ADMIN" "PARTNER" "USER" … 1 more

Перечень ролей пользователя.

timezone
integer<int32> [ -12 .. 12 ]
Default: 0

Базовая временная зона, которая используется для расчета статистики.

Request samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "password": "my_password",
  • "name": "my_visible_name",
  • "email": "admin@company.com",
  • "phone": "+71112223333",
  • "company_key": "my_company",
  • "enabled": true,
  • "roles": [ ],
  • "timezone": 3
}

Response samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "name": "my_visible_name",
  • "email": "admin@company.com",
  • "phone": "+71112223333",
  • "company_key": "my_company",
  • "enabled": true,
  • "roles": [ ],
  • "timezone": 3
}

Список пользователей

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

Authorizations:
ApiKeyAuth
query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

filter
string [ 1 .. 64 ] characters
Example: filter=example text

Фильтр для поиска по текстовым полям.

sort_field
string [ 1 .. 64 ] characters
Example: sort_field=name

Поле, по которому необходимо делать сортировку.

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

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

company_key
string (company_key) [ 3 .. 256 ] characters \w+
Example: company_key=my_company

Ключ компании, которая объединяет разных пользователей в одну группу.

user_group
string (user_groups)
Default: "TOTAL"
Enum: "TOTAL" "ACTIVE" "BLOCKED" … 1 more
Example: user_group=ACTIVE

Логические группы пользователей.

Responses

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

Список пользователей.

required
object (user_list_stats)

Статистика по списку пользователей.

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "statistics": {
    }
}

Информация о пользователе

Получение информации о пользователе по его логину.

Authorizations:
ApiKeyAuth
path Parameters
username
required
string (user_name) [ 2 .. 256 ] characters \w+
Example: my_username_for_login

Логин, уникальный идентификатор пользователя.

Responses

Response Schema: application/json
username
required
string (user_name) [ 2 .. 256 ] characters \w+

Логин, уникальный идентификатор пользователя.

name
string or null [ 2 .. 256 ] characters
Default: null

ФИО пользователя.

email
string or null<email> [ 5 .. 256 ] characters
Default: null

Почта пользователя.

phone
string or null [ 5 .. 32 ] characters
Default: null

Телефон пользователя.

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

Ключ компании, которая объединяет разных пользователей в одну группу.

enabled
boolean
Default: true

Статус пользователя.

roles
required
Array of strings (user_roles) [ 0 .. 2 ] items unique
Items Enum: "ADMIN" "PARTNER" "USER" … 1 more

Перечень ролей пользователя.

timezone
integer<int32> [ -12 .. 12 ]
Default: 0

Базовая временная зона, которая используется для расчета статистики.

Response samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "name": "my_visible_name",
  • "email": "admin@company.com",
  • "phone": "+71112223333",
  • "company_key": "my_company",
  • "enabled": true,
  • "roles": [ ],
  • "timezone": 3
}

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

Удаление пользователя по его логину.

Authorizations:
ApiKeyAuth
path Parameters
username
required
string (user_name) [ 2 .. 256 ] characters \w+
Example: my_username_for_login

Логин, уникальный идентификатор пользователя.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "Bad Request"
}

Audit

Пользовательские действия.

Действия пользователей

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

Authorizations:
ApiKeyAuth
query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

from
string<date-time>
Example: from=2024-02-21T09:30:00+03:00

Дата и время в соответствии с ISO 8601, начиная с которого (включительно) будет производится выгрузка данных. Если не указано - возвращаются данные с начала текущего дня.

to
string<date-time>
Example: to=2024-02-21T18:00:00+03:00

Дата и время в соответствии с ISO 8601, до которого (включительно) будет производится выгрузка данных. Если не указано - возвращаются данные до текущего времени.

company_key
string (company_key) [ 3 .. 256 ] characters \w+
Example: company_key=my_company

Ключ компании, которая объединяет разных пользователей в одну группу.

username
string (user_name) [ 2 .. 256 ] characters \w+
Example: username=my_username_for_login

Логин, уникальный идентификатор пользователя.

service_name
string (service_name)
Enum: "UNIVERSAL" "ROUTING" "ACCOUNT" … 9 more
Example: service_name=UNIVERSAL

Название сервиса.

operation_id
string (operation_id) [ 3 .. 256 ] characters
Example: operation_id=run_plan_calculation

Идентификатор операции.

method_group
string (method_group)
Enum: "NOTRACE" "TRACE" "PLAN" … 9 more
Example: method_group=PLAN

Название группы метода.

sort_field
string [ 1 .. 64 ] characters
Example: sort_field=name

Поле, по которому необходимо делать сортировку.

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

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

Responses

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

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

required
object (audit_stats)

Статистика по списку записей.

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "statistics": {
    }
}

Data

Пользовательские данные.

Чтение данных

Получение данных по tracecode.

Authorizations:
ApiKeyAuth
path Parameters
tracecode
required
string<uuid>
Example: 11111111-2222-3333-4444-555555555555

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

query Parameters
data_flow_type
string (flow_type)
Default: "INPUT"
Enum: "INPUT" "OUTPUT"
Example: data_flow_type=OUTPUT

Тип потока обработки данных.

data_flow_stage
integer<int32> [ 0 .. 3 ]
Default: 0
Example: data_flow_stage=1

Этап потока обработки данных.

data_flow_convert
string (flow_convert)
Deprecated
Default: "ORIGIN"
Enum: "ORIGIN" "JSON" "XLSX"
Example: data_flow_convert=JSON

Конвертация возвращаемых данных.

Responses

Response Schema: application/octet-stream
string<byte> (file_xlsx)

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

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "Bad Request"
}

Statistics

Статистика.

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

Статистика по пользователям за период. Если пользователь не указывается - статистика возвращается по всем пользователям. Если период не указывается - возвращается статистика за текущий месяц (с начала месяца по текущий день, не включая текущий день). Если дата "с" не указана - берется начало текущего месяца. Если дата "по" не указана - берется текущий день (не включая его).

Authorizations:
ApiKeyAuth
query Parameters
username
string (user_name) [ 2 .. 256 ] characters \w+
Example: username=my_username_for_login

Логин, уникальный идентификатор пользователя.

from
string<date>
Example: from=2024-02-22

Дата в формате YYYY-MM-DD, начиная с которой будет производится выгрузка данных.

to
string<date>
Example: to=2024-02-22

Дата в формате YYYY-MM-DD, по которую включительно будет производится выгрузка данных.

Responses

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

Список статистик по пользователям.

Response samples

Content type
application/json
{
  • "users": [
    ]
}

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

Отчет по пользователям за период. Если пользователь не указывается - отчет возвращается по всем пользователям. Если период не указывается - возвращается отчет за текущий месяц (с начала месяца по текущий день, не включая текущий день). Если дата "с" не указана - берется начало текущего месяца. Если дата "по" не указана - берется текущий день (не включая его).

Authorizations:
ApiKeyAuth
query Parameters
username
string (user_name) [ 2 .. 256 ] characters \w+
Example: username=my_username_for_login

Логин, уникальный идентификатор пользователя.

from
string<date>
Example: from=2024-02-22

Дата в формате YYYY-MM-DD, начиная с которой будет производится выгрузка данных.

to
string<date>
Example: to=2024-02-22

Дата в формате YYYY-MM-DD, по которую включительно будет производится выгрузка данных.

Responses

Response Schema: application/octet-stream
string<byte> (file_xlsx)

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

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "Bad Request"
}

Quotas

Квотирование.

Установка квот

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

Authorizations:
ApiKeyAuth
path Parameters
username
required
string (user_name) [ 2 .. 256 ] characters \w+
Example: my_username_for_login

Логин, уникальный идентификатор пользователя.

Request Body schema: application/json
required

Запрос на изменение квоты на дату.

required
Array of objects (service_quota) [ 1 .. 100 ] items unique

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

Responses

Request samples

Content type
application/json
{
  • "services": [
    ]
}

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "Bad Request"
}

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

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

Authorizations:
ApiKeyAuth
path Parameters
username
required
string (user_name) [ 2 .. 256 ] characters \w+
Example: my_username_for_login

Логин, уникальный идентификатор пользователя.

Responses

Response Schema: application/json
required
object (quota_base)

Квота на все сервисы.

Response samples

Content type
application/json
{
  • "base": {
    }
}

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

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

Authorizations:
ApiKeyAuth
path Parameters
username
required
string (user_name) [ 2 .. 256 ] characters \w+
Example: my_username_for_login

Логин, уникальный идентификатор пользователя.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "Bad Request"
}

System

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

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

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

Responses

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

Текущий показатель здоровья сервиса.
0 означает неготовность сервиса выполнять задачи.
1 означает полную готовность сервиса для выполнения задач.

Response samples

Content type
application/json
{
  • "health": 0.999
}

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

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

Responses

Response Schema: application/json
major
required
integer<int32> [ 1 .. 100 ]

Версия продукта. В рамках одной версии гарантируется совместимость общих структур данных между сервисами.
Изменение версии указывает на несовместимые с предыдущими версиями продукта (и, соответственно, всех сервисов) изменения.

minor
required
integer<int32> [ 0 .. 111 ]

Минорная версия сервиса. Изменение версии указывает на новую функциональность. Обновление имеет обратную совместимость в рамках мажорной версии сервиса.

build
required
string [ 1 .. 64 ] characters

Версия сборки.
Изменяется при обновлении документации и исправлении ошибок.

Response samples

Content type
application/json
{
  • "major": 4,
  • "minor": 4,
  • "build": "1754RC"
}

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

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

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
{
  • "resource_id": "resource_id",
  • "detail": {
    }
}