Методы группы Extension внешнего программного интерфейса Менеджера сервиса предназначены для работы с каталогом расширений.
Для выполнения всех методов этой группы пользователь, от имени которого вызывается программный интерфейс, должен обладать следующей ролью:
- Владелец абонента.
Сводка по методам
Метод | Примечание |
---|---|
root | |
Возвращает список доступных расширений. | |
info | Возвращает информацию об указанном расширении. |
instances | |
list | Возвращает список установленных в приложения экземпляров расширений. |
status | Возвращает информацию о статусе указанном экземпляре расширения. |
install | Инициирует установку расширения в приложение. |
remove | Инициирует удаление ранее установленного расширения из приложения. |
extension/list
Метод возвращает список расширений, доступных абоненту. Эту же информацию можно получить, выполнив команду "Адаптация" в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
Ответ: extension (0..*) | ||
id | Строка | Идентификатор расширения |
owner | Строка | Владелец расширения |
extension/info
Метод возвращает информацию об указанном расширении. Эту же информацию можно получить, открыв карточку расширения в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
id | Строка | Идентификатор расширения |
Ответ: extension (1) | ||
id | Строка | Идентификатор расширения |
owner | Строка | Владелец расширения |
description | Строка | Описание расширения |
tenant | Массив | Области данных, в которые можно установить расширение.
|
extension/instances/list
Метод возвращает список зкземпляров расширения (декартово произведение таблицы расширений и таблицы областей данных, в которые расширение может быть установлено). Эту же информацию можно получить, выполнив команду "Установка и удаление" в карточке расширения в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
id | Строка | Идентификатор расширения |
Ответ: instance (0..*) | ||
id | Строка | Идентификатор расширения |
tenant | Число | Номер области |
status | Строка | Состояние экземпляра (перечисление) |
Возможные значения поля status:
none - Отсутствует
during_installation - Устанавливается
installed - Установлено
during_removal - Удаляется
installation_error - Ошибка установки
removal_error - Ошибка удаления
extension/instances/status
Метод возвращает статус указанного экземпляра расширения (пары "расширение - область данных"). Эту же информацию можно получить, выполнив команду "Установка и удаление" в карточке расширения в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
id | Строка | Идентификатор расширения |
tenant | Число | Номер области |
Ответ: instance (1) | ||
status | Строка | Состояние экземпляра (перечисление) |
Возможные значения поля status указаны в описании метода extension/instances/list .
extension/instances/install
Метод инициирует установку расширения в указанную область. Метод выполняется асинхронно, результат необходимо проверить вызовом метода extension/instances/status. Выполнение метода равнозначно выполнению команды "Установить" в карточке расширения в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
id | Строка | Идентификатор расширения |
tenant | Число | Номер области |
Ответ: (1) | ||
Нет параметров |
extension/instances/remove
Метод инициирует удаление расширения из указанной области. Метод выполняется асинхронно, результат необходимо проверить вызовом метода extension/instances/status. Выполнение метода равнозначно выполнению команды "Удалить" в карточке расширения в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
id | Строка | Идентификатор расширения |
tenant | Число | Номер области |
Ответ: (1) | ||
Нет параметров |