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

Для выполнения всех методов этой группы пользователь, от имени которого вызывается программный интерфейс, должен обладать следующей ролью:

  • Владелец абонента.

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

Метод

Примечание

root

list 

Возвращает список доступных расширений.

infoВозвращает информацию об указанном расширении.
instances
listВозвращает список установленных в приложения экземпляров расширений.
statusВозвращает информацию о статусе указанном экземпляре расширения.
installИнициирует установку расширения в приложение.
removeИнициирует удаление ранее установленного расширения из приложения.

 Вверх

extension/list

Метод возвращает список расширений, доступных абоненту. Эту же информацию можно получить, выполнив команду "Адаптация" в интерфейсе Личного кабинета.

Параметр

Тип

Примечание

Запрос

accountЧислоКод абонента.

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

id

Строка

Идентификатор расширения

ownerСтрокаВладелец расширения

 Вверх

extension/info

Метод возвращает информацию об указанном расширении. Эту же информацию можно получить, открыв карточку расширения в интерфейсе Личного кабинета.

Параметр

Тип

Примечание

Запрос

accountЧислоКод абонента.
idСтрокаИдентификатор расширения

Ответ: extension (1)

id

Строка

Идентификатор расширения

ownerСтрокаВладелец расширения
descriptionСтрокаОписание расширения
tenantМассив

Области данных, в которые можно установить расширение.

  • id - Число - номер области

 Вверх

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)

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

 Вверх