Группа методов Tenant внешнего программного интерфейса Менеджера сервиса предназначена для управления приложениями абонента.
Сводка по методам
Метод | Назначение |
---|---|
tenant/create | Создать новое приложение |
tenant/create_for_migration | Создать приложение для миграции |
tenant/create_from_data_dump | Создать приложение из файла выгрузки данных приложения |
tenant/delete | Удалить приложение |
tenant/extensions | Список расширений приложения |
tenant/get_demo | Создает новое или возвращает уже созданное демо приложение. Является частично асинхронным. Пока приложение готовится, возвращается код ответа - 10202. |
tenant/info | Информация о приложении |
tenant/list | Список приложений |
tenant/new_name | Формирует имя для нового приложения |
tenant/set_name | Установить наименование приложения |
tenant/set_timezone | Установить часовой пояс приложения |
tenant/backup/create | Запланировать создание архивной копии приложения |
tenant/backup/list | Список архивных копий приложения |
tenant/backup_settings/get | Получить настройки резервного копирования приложения |
tenant/backup_settings/reset | Установить стандартные настроки резервного копирования приложения |
tenant/backup_settings/update | Установить настроки резервного копирования приложения |
tenant/users/add | Предоставить доступ пользователю к приложению |
tenant/users/delete | Отменить доступ пользователя к приложению |
tenant/users/list | Список пользователей, которым разрешен доступ к приложению |
tenant/users/set_role | Установить роль пользователя для работы в приложении |
tenant/account | Информация по абоненту, которому принадлежит приложение |
tenant/create
Создать новое приложение
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
application | Строка переменная (22) | Код вида приложения | mt |
name * | Строка переменная (100) | Название приложения | Мое приложение |
timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
users * | Права на приложения. Если не указано, пользователям устанавливаются права по умолчанию. | ||
- login | Строка переменная (50) | Логин пользователя | Abramov |
- role * | Строка (перечисление) | Роль пользователя абонента:
| administrator |
Ответ | |||
tenant * | Информация о созданном приложении | ||
- id | Число (+7.0) | Номер приложения | 1998 |
- url | Строка неограниченной длины | Адрес приложения | http://example.com/mt/1998 |
- status | Строка (перечисление) | Статус приложения:
| used |
general | Общие поля ответа | ||
- response | Число (+5.0) | Код возврата:
| 10202 |
- error | Булево | Флаг ошибки. Истина означает, что при выполнении метода возникла ошибка | false |
- message * | Строка неограниченной длины | Описание ошибки | |
- version | Число (+5.0) | Версия API, которая была задействована при выполнении запроса | 31 |
- sm_version | Строка переменная (18) | Версия конфигурации менеджера сервиса | 1.1.39.17 |
- sm_timezone | Строка переменная (100) | Часовой пояс информационной базы менеджера сервиса | Europe/Moscow |
tenant/create_for_migration
Создать приложение для миграции
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id * | Число (+12.0) | (не используется) Код абонента | 1010 |
application | Строка переменная (255) | Имя вида приложения | РаботаВМоделиСервиса |
version | Строка переменная (18) | Номер версии | 1.1.3.10 |
extensions * | Расширения для установки | ||
- id | Строка неограниченной длины | Имя расширения | МоеРасширение1 |
- version | Строка переменная (20) | Версия расширения | 1.0.0.1 |
- PlusExtVersionId * | Строка переменная (36) | Идентификатор версии расширения 1С:Плюс | 032d1f48-3486-48a4-a4a7-2f17c6efa837 |
- PlusVersionId * | Строка переменная (36) | Идентификатор расширения 1С:Плюс | 53dfb6e0-7bae-4cda-af9b-84ec775d42df |
name | Строка переменная (100) | Название приложения | Мое приложение |
timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
users | Список пользователей сервиса для сопоставления | ||
- login | Строка переменная (50) | Логин пользователя | Abramov |
- role * | Строка (перечисление) | Роль пользователя абонента:
| administrator |
- userid * | Уникальный идентификатор | Идентификатор пользователя базы источника | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
Ответ | |||
tenant * | Информация о приложении для миграции | ||
- id | Число (+7.0) | Номер приложения | 2001 |
- url | Строка неограниченной длины | Адрес приложения | http://example.com/mt/2001 |
- login | Строка переменная (50) | Логин временного пользователя | migration |
- password | Строка неограниченной длины | Пароль временного пользователя | Fg53wS1 |
- status | Строка (перечисление) | Статус приложения:
| preparation |
general | Общие поля ответа | ||
- response | Число (+5.0) | Код возврата:
| 10202 |
- error | Булево | Флаг ошибки. Истина означает, что при выполнении метода возникла ошибка | false |
- message * | Строка неограниченной длины | Описание ошибки | |
- version | Число (+5.0) | Версия API, которая была задействована при выполнении запроса | 31 |
- sm_version | Строка переменная (18) | Версия конфигурации менеджера сервиса | 1.1.39.17 |
- sm_timezone | Строка переменная (100) | Часовой пояс информационной базы менеджера сервиса | Europe/Moscow |
tenant/create_from_data_dump
Создать приложение из файла выгрузки данных приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
file_id | Уникальный идентификатор | Идентификатор (UUID) файла данных приложения, загруженного в Менеджер сервиса. | 65cd1354-eda2-4425-9d1c-679f6804e318 |
name | Строка переменная (100) | Название приложения | Мое приложение |
timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
users | Список пользователей сервиса для сопоставления | ||
- login | Строка переменная (50) | Логин пользователя | Abramov |
- role * | Строка (перечисление) | Роль пользователя абонента:
| administrator |
- user_id * | Уникальный идентификатор | Идентификатор пользователя из файла данных | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
extensions * | Расширения для установки | ||
- version_uuid | Уникальный идентификатор | Идентификатор версии расширения | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
- id | Строка переменная (260) | Имя расширения | МоеРасширение |
- restore_frame * | Булево | Установить каркасную версию расширения | false |
Ответ | |||
tenant * | Информация о созданном приложении | ||
- id | Число (+7.0) | Номер приложения | 2001 |
- url | Строка неограниченной длины | Адрес приложения | http://example.com/mt/2001 |
- status | Строка (перечисление) | Статус приложения:
| preparation |
general | Общие поля ответа | ||
- response | Число (+5.0) | Код возврата:
| 10202 |
- error | Булево | Флаг ошибки. Истина означает, что при выполнении метода возникла ошибка | false |
- message * | Строка неограниченной длины | Описание ошибки | |
- version | Число (+5.0) | Версия API, которая была задействована при выполнении запроса | 31 |
- sm_version | Строка переменная (18) | Версия конфигурации менеджера сервиса | 1.1.39.17 |
- sm_timezone | Строка переменная (100) | Часовой пояс информационной базы менеджера сервиса | Europe/Moscow |
tenant/delete
Удалить приложение
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
create_backup * | Булево | Создать архивную копию перед удалением | true |
Ответ | |||
Нет параметров |
tenant/extensions
Список расширений приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
account | Число (+12.0) | Код абонента | 1010 |
id | Число (+7.0) | Номер приложения | 2000 |
Ответ: extension (0..*) | |||
id | Строка переменная (260) | Имя расширения | МоеРасширение |
status | Строка (перечисление) | Состояние экземпляра расширения:
| installed |
tenant/get_demo
Создает новое или возвращает уже созданное демо приложение. Является частично асинхронным. Пока приложение готовится, возвращается код ответа - 10202.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
apptype_id | Строка переменная (22) | Код вида приложения | demo |
Ответ: tenant (1) | |||
id | Число (+7.0) | Номер приложения | 1998 |
name | Строка переменная (100) | Название приложения | Демонстрационное приложение (демо) |
apptype_id | Строка переменная (22) | Код вида приложения | demo |
apptype_name | Строка переменная (255) | Имя вида приложения | ДемонстрационноеПриложение |
apptype_presentation | Строка переменная (150) | Наименование вида приложения | Демонстрационное приложение |
app_version | Строка переменная (18) | Версия конфигурации | 2.0.14.10 |
url | Строка неограниченной длины | Адрес приложения | http://example.com/a/demo/1998 |
status | Строка (перечисление) | Статус приложения:
| used |
tenant/info
Информация о приложении
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
Ответ: tenant (1) | |||
id | Число (+7.0) | Номер приложения | 2000 |
name | Строка переменная (100) | Название приложения | Мое приложение |
application | Строка переменная (22) | Код вида приложения (устарело) | mt |
app_version | Строка переменная (18) | Версия конфигурации | 2.0.14.10 |
app_name | Строка переменная (64) | Наименование конфигурации | Работа в модели сервиса |
apptype_id | Строка переменная (22) | Код вида приложения | mt |
apptype_name | Строка переменная (255) | Имя вида приложения | РаботаВМоделиСервиса |
apptype_presentation | Строка переменная (150) | Наименование вида приложения | Работа в модели сервиса |
timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
owner | Число (+12.0) | Код абонента | 1010 |
status | Строка (перечисление) | Статус приложения:
| used |
url | Строка неограниченной длины | Адрес приложения | http://example.com/mt/2000 |
platform * | Строка переменная (18) | Версия платформы 1С:Предприятие | 8.3.1.1 |
size * | Число (+15.0) | Размер приложения | 102400 |
size_calc_date * | Дата и время в строке формата ISO | Дата расчета размера приложения | 01.12.2024 21:07:19 |
tenant/list
Список приложений
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
name * | Строка переменная (100) | Фильтр по наименованию приложения | Мое |
application * | Массив из Строка переменная (22) | Фильтр по коду вида приложения | ["smtl"] |
status * | Массив из Строка (перечисление) | Фильтр по статусу приложения:
| ["used"] |
Ответ: tenant (1..*) | |||
id | Число (+7.0) | Номер приложения | 2000 |
name | Строка переменная (100) | Название приложения | Мое приложение |
application | Строка переменная (22) | Код вида приложения (устарело) | mt |
app_version | Строка переменная (18) | Версия конфигурации | 2.0.14.10 |
app_name | Строка переменная (64) | Наименование конфигурации | Работа в модели сервиса |
apptype_id | Строка переменная (22) | Код вида приложения | mt |
apptype_name | Строка переменная (255) | Имя вида приложения | РаботаВМоделиСервиса |
apptype_presentation | Строка переменная (150) | Наименование вида приложения | Работа в модели сервиса |
timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
owner | Число (+12.0) | Код абонента | 1010 |
status | Строка (перечисление) | Статус приложения:
| used |
url | Строка неограниченной длины | Адрес приложения | http://example.com/mt/2000 |
tenant/new_name
Формирует имя для нового приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
apptype_id | Строка переменная (22) | Код вида приложения | mt |
Ответ: name (1) | |||
Нет параметров |
tenant/set_name
Установить наименование приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
name | Строка переменная (100) | Название приложения | Мое приложение |
Ответ: name (1) | |||
Нет параметров |
tenant/set_timezone
Установить часовой пояс приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
timezone | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
Ответ: name (1) | |||
Нет параметров |
tenant/backup/create
Запланировать создание архивной копии приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
planned_date * | Дата и время в строке формата ISO | Момент, на который необходимо запланировать создание копии | 28.02.2019 0:00:00 |
forced * | Булево | Удалить все сеансы перед запуском копирования | false |
Ответ: name (1) | |||
Нет параметров |
tenant/backup/list
Список архивных копий приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
start_date * | Дата и время в строке формата ISO | Дата создания РК. Начальная, для отбора по периоду | 28.02.2019 0:00:00 |
end_date * | Дата и время в строке формата ISO | Дата создания РК. Конечная, для отбора по периоду | 26.03.2020 0:00:00 |
Ответ: backup (0..*) | |||
tenant | Число (+7.0) | Номер приложения | 2000 |
tenant_name | Строка переменная (100) | Название приложения | Мое приложение |
id | Уникальный идентификатор | Идентификатор копии | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
conf_name | Строка переменная (255) | Имя конфигурации, как оно задано в конфигураторе | РаботаВМоделиСервиса |
app_version | Строка переменная (18) | Версия конфигурации | 1.1.3.10 |
app_name | Строка переменная (150) | Наименование вида приложения | Работа в модели сервиса |
application | Строка переменная (22) | Код вида приложения | mt |
utc_timestamp | Дата и время в строке формата ISO | Момент создания (универсальное время) | 21.03.2019 0:00:00 |
timestamp | Дата и время в строке формата ISO | Момент создания (местное время) | 21.03.2019 3:00:00 |
size | Число (+15.0) | Размер файла | 12345 |
is_original | Булево | Это исходный образ приложения | false |
is_ondemand | Булево | Это копия по требованию | true |
is_annual | Булево | Это ежегодная копия | false |
is_monthly | Булево | Это ежемесячная копия | false |
is_daily | Булево | Это ежедневная копия | false |
for_support | Булево | Это копия для тех. поддержки | false |
comment * | Строка неограниченной длины | Комментарий к архивной копии | Копия перед отчетным периодом |
timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
tenant/backup_settings/get
Получить настройки резервного копирования приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
Ответ: settings (1) | |||
daily | Булево | Формировать ежедневные копии | true |
monthly | Булево | Формировать ежемесячные копии | true |
annual | Булево | Формировать ежегодные копии | true |
start | Дата в строке формата ISO (только время) | Время начала формирования | 01.01.0001 2:00:00 |
completion | Дата в строке формата ISO (только время) | Время завершения формирования | 01.01.0001 8:00:00 |
monthly_day | Число (+2.0) | День формирования ежемесячных копий | 1 |
annual_month | Число (+2.0) | Месяц формирования ежегодных копий | 1 |
annual_day | Число (+2.0) | День месяца формирования ежегодных копий | 1 |
daily_count | Число (+2.0) | Количество хранимых ежедневных копий | 3 |
monthly_count | Число (+2.0) | Количество хранимых ежемесячных копий | 2 |
annual_count | Число (+2.0) | Количество хранимых ежегодных копий | 3 |
only_work_days | Булево | Формировать архивные копии только в дни работы | true |
tenant/backup_settings/reset
Установить стандартные настроки резервного копирования приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
Ответ: settings (1) | |||
Нет параметров |
tenant/backup_settings/update
Установить настроки резервного копирования приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
daily * | Булево | Формировать ежедневные копии | true |
monthly * | Булево | Формировать ежемесячные копии | true |
annual * | Булево | Формировать ежегодные копии | true |
start * | Дата в строке формата ISO (только время) | Время начала формирования | 01.01.0001 2:00:00 |
completion * | Дата в строке формата ISO (только время) | Время завершения формирования | 01.01.0001 8:00:00 |
monthly_day * | Число (+2.0) | День формирования ежемесячных копий | 1 |
annual_month * | Число (+2.0) | Месяц формирования ежегодных копий | 1 |
annual_day * | Число (+2.0) | День месяца формирования ежегодных копий | 1 |
daily_count * | Число (+2.0) | Количество хранимых ежедневных копий | 3 |
monthly_count * | Число (+2.0) | Количество хранимых ежемесячных копий | 2 |
annual_count * | Число (+2.0) | Количество хранимых ежегодных копий | 3 |
only_work_days * | Булево | Формировать архивные копии только в дни работы | true |
Ответ: settings (1) | |||
Нет параметров |
tenant/users/add
Предоставить доступ пользователю к приложению
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
login | Строка переменная (50) | Логин пользователя | Abramov |
role | Строка (перечисление) | Роль пользователя абонента:
| administrator |
Ответ: settings (1) | |||
Нет параметров |
tenant/users/delete
Отменить доступ пользователя к приложению
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
login | Строка переменная (50) | Логин пользователя | Abramov |
Ответ: settings (1) | |||
Нет параметров |
tenant/users/list
Список пользователей, которым разрешен доступ к приложению
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
login * | Строка переменная (50) | Фильтр по логину пользователя | Abram |
Ответ: user (0..*) | |||
login | Строка переменная (50) | Логин пользователя | Abramov |
role | Строка (перечисление) | Роль пользователя абонента:
| administrator |
setup_required * | Булево | Требуется настройка прав в приложении | false |
tenant/users/set_role
Установить роль пользователя для работы в приложении
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
login | Строка переменная (50) | Логин пользователя | Abramov |
role | Строка (перечисление) | Роль пользователя абонента:
| administrator |
Ответ: user (0..*) | |||
Нет параметров |
tenant/account
Информация по абоненту, которому принадлежит приложение
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+7.0) | Номер приложения | 2000 |
Ответ: account (1) | |||
id | Число (+12.0) | Код абонента | 1010 |
name | Строка переменная (64) | Наименование абонента | Конфетпром |
role * | Строка (перечисление) | Роль пользователя абонента:
| owner |
uid | Строка переменная (64) | Уникальный идентификатор абонента | 340578b0-a93b-11e9-e193-0242c0a85004 |