Группа методов Tenant внешнего программного интерфейса Менеджера сервиса предназначена для управления приложениями абонента.

Сводка по методам

Метод

Примечание

root

list

Возвращает области, принадлежащие указанному абоненту.

info

Возвращает информацию об указанной области.

account

Возвращает информацию абонента, которому принадлежит приложение (область данных).

create

Создает новую область.

create_from_data_dumpСоздает новую область из файла выгрузки данных приложения
create_for_migrationСоздает новую область для миграции приложения.

delete

Помечает область к удалению.

set_name

Устанавливает новое имя для области.

set_timezone

Устанавливает новый часовой пояс для области.

extensionsВозвращает список расширений области (включая доступные к установке).

 users

list

Возвращает список пользователей, которым доступна работа в области.

add

Дает новому пользователю доступ в область (пользователь сервиса не создается).

delete

Удаляет существующего пользователя из списка допущенных в область (пользователь сервиса не удаляется).

set_role

Устанавливает пользователю роль в приложении.

backup

list

Возвращает список архивных копий области.

create

Создает задание на архивирование области.

backup_settings
getВозвращает настройки резервирования области.
updateОбновляет настройки резервирования области.
resetСбрасывает настройки резервирования области на значения по умолчанию.

tenant/list

 Метод возвращает список приложений, доступных пользователю. 

Параметр

Тип

Примечание

Запрос

нет параметров

Ответ: tenant (0..*)

id

 Число

Номер области. 

name

Строка

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

owner

Число

Код абонента-владельца

application

Строка

Код конфигурации.

app_version

Строка

Версия конфигурации.

app_name

Строка

Название конфигурации.

status

Строка

Статус области (перечисление).

url

Строка

Адрес области (с учетом витрины).

timezone

Строка

Часовой пояс области.

Возможные значения поля status:

  • ready - Готово
  • preparation - Готовится к использованию
  • used - Используется
  • converted - Конвертируется
  • copied - Копируется
  • decommissioned - К удалению
  • new - Новая
  • missing - Отсутствует
  • error - Ошибка подготовки
  • removed - Удалено
Пример запроса
POST {{server}}/{{url}}
Authorization: {{authorization}}
 
{ 
   "general":{ 
      "type":"usr",
      "method":"tenant/list"
   },
   "auth": {
     "account":{{account}}
   }
}

 Вверх

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
Пример запроса  Развернуть
{
  "file_id": "65cd1354-eda2-4425-9d1c-679f6804e318",
  "name": "Мое приложение",
  "timezone": "Europe/Moscow",
  "users": [
    {
      "login": "Abramov",
      "role": "administrator",
      "user_id": "abf7c2a7-1df7-4646-9327-2866804b6ce2"
    }
  ],
  "auth": {
    "account": 1010
  },
  "general": {
    "version": 12,
    "type": "usr",
    "method": "tenant/create_from_data_dump",
    "debug": true
  }
}
Пример ответа  Развернуть
{
  "tenant": {
    "id": 2001,
    "url": "http://example.com/mt/2001",
    "status": "preparation"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 12,
    "sm_version": "1.0.98.5",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх

tenant/create_for_migration

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

Параметр

Тип

Примечание

Запрос

application

Строка


Имя конфигурации.

version

Строка

Версия конфигурации.

nameСтрокаНазвание области.
timezoneСтрокаЧасовой пояс области.
usersМассив

Массив объектов с полями:

  • login - Строка - Логин пользователя в сервисе.
  • role - Строка - administrator, user или пустая строка.
  • userid - Строка - уникальный идентификатор пользователя из базы источника.

Ответ 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_count10Количество хранимых ежедневных копий.
monthly_count6Количество хранимых ежемесячных копий.
annual_countЧислоКоличество хранимых ежегодных копий.

 Вверх

tenant/backup_settings/reset

Метод устанавливает для указанной области настройки резервного копирования по умолчанию. Выполнение метода равнозначно выполнению команд "Резервное копирование - Настройки резервного копирования - Установить стандартные настройки" в интерфейсе Личного кабинета.

Параметр

Тип

Примечание

Запрос

id

 Число

Номер области. 

Ответ (1)



Нет параметров



Значение настроек по умолчанию приведены в таблице:

ПараметрЗначениеПримечание
start02:00:00Момент начала формирования архивных копий.
completion08:00:00Момент завершения формирования архивных копий.
dailyИстинаФормировать ежедневные архивные копии.
daily_count3Количество хранимых ежедневных копий.
monthlyИстинаФормировать ежемесячные архивные копии.
monthly_count2Количество хранимых ежемесячных копий.
monthly_day1День месяца, в который необходимо формировать ежемесячные копии.
annualИстинаФормировать ежегодные архивные копии.
annual_count3Количество хранимых ежегодных копий.
annual_day1День месяца, в который необходимо формировать ежегодную копию.
annual_month1Месяц, в который необходимо формировать ежегодную копию.
only_work_daysИстинаФормировать архивные копии только в дни работы пользователей.

 Вверх