Группа методов Tenant внешнего программного интерфейса Менеджера сервиса предназначена для управления приложениями абонента.
Сводка по методам
Метод | Примечание |
---|---|
root | |
Возвращает области, принадлежащие указанному абоненту. | |
Возвращает информацию об указанной области. | |
Возвращает информацию абонента, которому принадлежит приложение (область данных). | |
Создает новую область. | |
create_from_data_dump | Создает новую область из файла выгрузки данных приложения |
create_for_migration | Создает новую область для миграции приложения. |
Помечает область к удалению. | |
Устанавливает новое имя для области. | |
Устанавливает новый часовой пояс для области. | |
extensions | Возвращает список расширений области (включая доступные к установке). |
users | |
Возвращает список пользователей, которым доступна работа в области. | |
Дает новому пользователю доступ в область (пользователь сервиса не создается). | |
Удаляет существующего пользователя из списка допущенных в область (пользователь сервиса не удаляется). | |
Устанавливает пользователю роль в приложении. | |
backup | |
Возвращает список архивных копий области. | |
Создает задание на архивирование области. | |
backup_settings | |
get | Возвращает настройки резервирования области. |
update | Обновляет настройки резервирования области. |
reset | Сбрасывает настройки резервирования области на значения по умолчанию. |
tenant/list
Метод возвращает список приложений, доступных пользователю.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
name | Строка | Фильтр по наименованию приложения |
application | Строка | Фильтр по коду вида приложения |
status | Строка | Фильтр по статусу приложения |
нет параметров | ||
Ответ: tenant (0..*) | ||
id | Число | Номер области. |
name | Строка | Название приложения. |
owner | Число | Код абонента-владельца |
application | Строка | Код вида приложения |
app_version | Строка | Версия конфигурации. |
app_name | Строка | Название конфигурации. |
status | Строка | Статус области (перечисление). |
url | Строка | Адрес области (с учетом витрины). |
timezone | Строка | Часовой пояс области. |
Возможные значения поля status:
- ready - Готово
- preparation - Готовится к использованию
- used - Используется
- converted - Конвертируется
- copied - Копируется
- decommissioned - К удалению
- new - Новая
- missing - Отсутствует
- error - Ошибка подготовки
- removed - Удалено
{ "name": "Мое", "application": ["smtl"], "status": ["used"], "auth": { "type": "user", "account": 1010 }, "general": { "version": 23, "type": "usr", "method": "tenant/list", "debug": true } }
{ "tenant": [ { "id": 2000, "name": "Мое приложение", "application": "mt", "app_version": "1.1.3.10", "app_name": "Работа в модели сервиса", "timezone": "Europe/Moscow", "owner": 1010, "status": "used", "url": "http://example.com/mt/2000" } ], "general": { "response": 10200, "error": false, "message": "", "version": 23, "sm_version": "1.1.20.3", "sm_timezone": "Europe/Moscow" } }
tenant/info
Метод возвращает информацию об указанном приложении. Поиск приложения выполняется по номеру области данных.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
Ответ: tenant (1) | ||
id | Число | Номер области. |
name | Строка | Название приложения. |
owner | Число | Код абонента-владельца. |
application | Строка | Код вида приложения |
app_version | Строка | Версия конфигурации. |
app_name | Строка | Название конфигурации. |
status | Строка | Статус области (перечисление). |
url | Строка | Адрес области (с учетом витрины). |
timezone | Строка | Часовой пояс области. |
Возможные значения поля status:
- ready - Готово
- preparation - Готовится к использованию
- used - Используется
- converted - Конвертируется
- copied - Копируется
- decommissioned - К удалению
- new - Новая
- missing - Отсутствует
- error - Ошибка подготовки
- removed - Удалено
tenant/account
Метод возвращает информацию абонента, которому принадлежит приложение (область данных).
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
Ответ: account(1) | ||
id | Число | Код абонента |
name | Строка | Название области. |
role | Число | Роль авторизованного пользователя по отношению к абоненту. |
uid | Строка | Уникальный код абонента |
Возможные значения роли пользователя указаны в описании метода account/users/set_role .
POST {{server}}/{{url}} Authorization: Basic {{auth}} { "auth": { "account": {{account}} }, "general": { "type": "usr", "method": "tenant/account" }, "id": {{id}} }
{ "account": { "id": 5, "name": "ОО \"Партнер\"", "role": "owner", "uid": "b131eac6-a706-11e9-e991-0242ac1c0004" }, "general": { "response": 10200, "error": false, "message": "", "version": 6, "sm_version": "1.0.82.31", "sm_timezone": "Europe/Moscow" } }
tenant/create
Метод создает новое приложение с указанной прикладной конфигурацией. Выполнение метода равнозначно выполнению команды "Добавить" в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
name * | Строка | Название области. |
application | Строка | Код вида приложения. |
timezone * | Строка | Часовой пояс области. |
Ответ: tenant (1) | ||
id | Число | Номер области. |
status | Строка | Статус области (перечисление). |
url | Строка | Адрес области (с учетом витрины). |
Возможные значения поля status:
- ready - Готово
- preparation - Готовится к использованию
- used - Используется
- converted - Конвертируется
- copied - Копируется
- decommissioned - К удалению
- new - Новая
- missing - Отсутствует
- error - Ошибка подготовки
- removed - Удалено
tenant/create_from_data_dump
Создать приложение из файла выгрузки данных приложения
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
file_id | Уникальный идентификатор | Идентификатор (UUID) файла данных приложения, загруженного в Менеджер сервиса. | 65cd1354-eda2-4425-9d1c-679f6804e318 |
name | Строка переменная (100) | Название приложения | Мое приложение |
timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
users | Список пользователей сервиса для сопоставления | ||
- login | Строка переменная (32) | Логин пользователя облачного сервиса | Abramov |
- role * | Строка неограниченной длины | Роль пользователя абонента | administrator |
- user_id * | Уникальный идентификатор | Идентификатор пользователя ИБ из файла данных | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
Ответ: tenant (1) | |||
id | Число (+7.0) | Номер приложения | 2001 |
url | Строка неограниченной длины | Адрес приложения | http://example.com/mt/2001 |
status | Строка неограниченной длины | Статус приложения | preparation |
tenant/create_for_migration
Создает приложение для миграции. Создает служебного пользователя, для выполнения загрузки данных.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
application | Строка | Имя вида приложения |
version | Строка | Версия конфигурации. |
name | Строка | Название приложения. |
timezone | Строка | Часовой пояс приложения. |
users | Массив | Массив объектов с полями:
|
Ответ tenant (1) | ||
id | Число | Номер области. |
url | Строка | Адрес области (с учетом витрины). |
login | Строка | Логин временного пользователя. |
password | Строка | Пароль временного пользователя. |
status | Строка | Статус области (перечисление). |
tenant/delete
Метод удаляет указанное приложение. Выполнение метода равнозначно выполнению команды "Удалить" в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
create_backup * | Булево | Указывает на необходимость создать архивную копию перед удалением. |
Ответ (1) | ||
нет параметров |
tenant/set_name
Метод устанавливает указанному приложению указанное название.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
name | Строка | Название области. |
Ответ (1) | ||
нет параметров |
tenant/set_timezone
Метод устанавливает указанному приложению указанный часовой пояс. Получить список допустимых для "1С:Предприятия" часовых поясов можно при помощи оператора встроенного языка ПолучитьДопустимыеЧасовыеПояса.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
timezone | Строка | Часовой пояс области. |
Ответ (1) | ||
нет параметров |
tenant/extensions
Метод возвращает перечень расширений, доступных к установке в указанную область (включая уже установленные). Прямых аналогов для этого метода в интерфейсе Личного кабинета нет. Для выполнения этого метода пользователь, от имени которого выполняется обращение к внешнему программному интерфейсу, должен обладать следующей ролью
- Владелец абонента
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
id | Число | Номер области. |
Ответ extension (0..*) | ||
id | Строка | Идентификатор расширения |
status | Строка | Статус экземпляра расширения в области (перечисление) |
Возможные значения поля status:
none - Отсутствует
during_installation - Устанавливается
installed - Установлено
during_removal - Удаляется
installation_error - Ошибка установки
removal_error - Ошибка удаления
tenant/users/list
Метод возвращает список пользователей, которым разрешен доступ к указанному приложению.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
Ответ: user (0..*) | ||
login | Строка | Логин пользователя. |
role | Строка | Роль пользователя в приложении (перечисление). |
Возможные значения поля role:
- user - Запуск
- administrator - Запуск и администрирование
- api - Доступ к API
tenant/users/add
Метод устанавливает пользователю с указанным логином доступ к указанному приложению и назначает указанную роль для работы в приложении. Выполнение метода равнозначно установке значения в колонке "Право" в карточке приложения в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
role | Строка | Роль нового пользователя в приложении (перечисление). |
login | Строка | Логин нового пользователя. |
Ответ (1) | ||
нет параметров |
Возможные значения поля role указаны в описании метода tenant/users/list .
POST {{server}}/{{url}} Authorization: {{authorization}} { "general":{ "type":"usr", "method":"tenant/users/add" }, "auth": { "account":{{account}} }, "id": {{tenant}}, "login":"{{login}}", "role": "{{tenant_role}}" }
tenant/users/delete
Метод отменяет пользователю с указанным логином доступ к указанному приложению. Выполнение метода равнозначно установке пустого значения в колонке "Право" в карточке приложения в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
login | Строка | Логин пользователя. |
Ответ (1) | ||
нет параметров |
tenant/users/set_role
Метод устанавливает пользователю с указанным логином указанную роль для работы в указанном приложении. Выполнение метода равнозначно изменению значения в колонке "Право" в карточке приложения в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
login | Строка | Логин пользователя. |
role | Строка | Роль нового в приложении (перечисление). |
Ответ (1) | ||
нет параметров |
Возможные значения поля role указаны в описании метода tenant/users/list .
tenant/backup/list
Метод возвращает список архивных копий указанного приложения. Для управления существующими архивными копиями следует использовать методы группы Backup .
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
start_date * | Дата и время в строке формата ISO | Выводить архивные копии с датой создания не ранее start_date |
end_date * | Дата и время в строке формата ISO | Выводить архивные копии с датой создания не позднее end_date |
Ответ: backup (0..*) | ||
id | Строка | Идентификатор резервной копии. |
application | Строка | Код вида приложения |
app_version | Строка | Версия конфигурации. |
timestamp | Дата | Момент создания резервной копии (часовой пояс области). |
utc_timestamp | Дата | Момент создания резервной копии (универсальное время). |
is_daily | Булево | Это ежедневная резервная копия. |
is_monthly | Булево | Это ежемесячная резервная копия. |
is_annual | Булево | Это ежегодная резервная копия. |
is_ondemand | Булево | Это резервная копия по требованию. |
is_original | Булево | Это исходный (самый первый) образ области. |
comment | Строка | Комментарий к архивной копии. |
tenant/backup/create
Метод регистрирует задание на создание новой архивной копии указанного приложения. Выполнение метода равнозначно выполнению команд "Резервное копирование - Создать резервную копию" в интерфейсе Личного кабинета. Для управления существующими архивными копиями следует использовать методы группы Backup .
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
planned_date * | Дата | Момент, на который необходимо запланировать создание копии (если не указан, то начать прямо сейчас). |
forced * | Булево | Удалить все сеансы, которые будут в области на момент запуска копирования (по умолчанию Ложь). |
Ответ (1) | ||
нет параметров |
tenant/backup_settings/get
Метод возвращает информацию о текущих настройках резервного копирования указанной области. Эту информацию в интерфейсе Личного кабинета можно получить, открыв карточку приложения и выполнив команды "Резервное копирование - Настройки резервного копирования".
Параметры типа "Дата и время" возвращают значение "текущая дата и установленное в настройках время".
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
Ответ: settings (1) | ||
start +* | Дата и время | Момент начала формирования архивных копий. |
completion +* | Дата и время | Момент завершения формирования архивных копий. |
daily | Булево | Формировать ежедневные архивные копии. |
daily_count +* | Число | Количество хранимых ежедневных копий. |
monthly | Булево | Формировать ежемесячные архивные копии. |
monthly_count +* | Число | Количество хранимых ежемесячных копий. |
monthly_day +* | Число | День месяца, в который необходимо формировать ежемесячные копии. |
annual | Булево | Формировать ежегодные архивные копии. |
annual_count +* | Число | Количество хранимых ежегодных копий. |
annual_day +* | Число | День месяца, в который необходимо формировать ежегодную копию. |
annual_month +* | Число | Месяц, в который необходимо формировать ежегодную копию. |
only_work_days | Булево | Формировать архивные копии только в дни работы пользователей. |
tenant/backup_settings/update
Метод устанавливает указанные значения настроек резервного копирования для указанной области. Выполнение метода равнозначно выполнению команд "Резервное копирование - Настройки резервного копирования - Записать и закрыть" в интерфейсе Личного кабинета.
Параметры типа "Дата и время" принимаются как "любая дата и время, которое необходимо установить в настройках".
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
start * | Дата и время | Момент начала формирования архивных копий. |
completion * | Дата и время | Момент завершения формирования архивных копий. |
daily * | Булево | Формировать ежедневные архивные копии. |
daily_count * | Число | Количество хранимых ежедневных копий. |
monthly * | Булево | Формировать ежемесячные архивные копии. |
monthly_count * | Число | Количество хранимых ежемесячных копий. |
monthly_day * | Число | День месяца, в который необходимо формировать ежемесячные копии. |
annual * | Булево | Формировать ежегодные архивные копии. |
annual_count * | Число | Количество хранимых ежегодных копий. |
annual_day * | Число | День месяца, в который необходимо формировать ежегодную копию. |
only_work_days | Истина | Формировать архивные копии только в дни работы пользователей. |
annual_month * | Число | Месяц, в который необходимо формировать ежегодную копию. |
only_work_days * | Булево | Формировать архивные копии только в дни работы пользователей. |
Ответ (1) | ||
Нет параметров |
При установке значений настройкам резервного копирования необходимо учесть, что для некоторых настроек значение не может превышать максимально допустисое. Если будет выполнена попытка установить для такой настройки значение, превышающее максимально допустимое, исключения не возникнет, но для настройки будет установлено максимально допустимое значение.
Параметр | Максимальное значение | Примечание |
---|---|---|
daily_count | 10 | Количество хранимых ежедневных копий. |
monthly_count | 6 | Количество хранимых ежемесячных копий. |
annual_count | Число | Количество хранимых ежегодных копий. |
tenant/backup_settings/reset
Метод устанавливает для указанной области настройки резервного копирования по умолчанию. Выполнение метода равнозначно выполнению команд "Резервное копирование - Настройки резервного копирования - Установить стандартные настройки" в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер области. |
Ответ (1) | ||
Нет параметров |
Значение настроек по умолчанию приведены в таблице:
Параметр | Значение | Примечание |
---|---|---|
start | 02:00:00 | Момент начала формирования архивных копий. |
completion | 08:00:00 | Момент завершения формирования архивных копий. |
daily | Истина | Формировать ежедневные архивные копии. |
daily_count | 3 | Количество хранимых ежедневных копий. |
monthly | Истина | Формировать ежемесячные архивные копии. |
monthly_count | 2 | Количество хранимых ежемесячных копий. |
monthly_day | 1 | День месяца, в который необходимо формировать ежемесячные копии. |
annual | Истина | Формировать ежегодные архивные копии. |
annual_count | 3 | Количество хранимых ежегодных копий. |
annual_day | 1 | День месяца, в который необходимо формировать ежегодную копию. |
annual_month | 1 | Месяц, в который необходимо формировать ежегодную копию. |
only_work_days | Истина | Формировать архивные копии только в дни работы пользователей. |