Extension — работа с каталогом расширений

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

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

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

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

Метод	Назначение
extension/list	Список расширений абонента
extension/list_for_compare	Список расширений абонента для сопоставления при миграции
extension/instances/install	Установить расширение в приложение
extension/instances/list	Список расширений и приложений для его установки
extension/instances/remove	Удалить расширение из приложения
extension/instances/status	Статус установки расширения в приложении
extension/info	Информация о расширении абонента

extension/list

Список расширений абонента

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
Ответ: extension (0..*)
id	Строка переменная (260)	Имя расширения	МоеРасширение
ext_system_id *	Строка переменная (150)	Идентификатор во внешней системе	1234567
owner	Число (+12.0)	Код абонента владельца	1010

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/extension/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "extension": [
    {
      "id": "МоеРасширение",
      "ext_system_id": "1234567",
      "owner": 1010
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

extension/list_for_compare

Список расширений абонента для сопоставления при миграции

Параметр	Тип	Описание	Пример
Запрос
sysversion	Строка неограниченной длины	Версия конфигурации	2.0.11.10
sysname *	Строка неограниченной длины	Имя конфигурации, как оно задано в конфигураторе. Обязательно, если не указан код вида приложения. Не указывается, если указан код вида приложения.	БиблиотекаТехнологииСервиса
apptype_id *	Строка переменная (22)	Код вида приложения. Обязательно, если не указано имя конфигурации. Не указывается, если указано имя конфигурации.	mt
account	Число (+12.0)	Код абонента	1010
Ответ: extension (0..*)
id	Строка переменная (260)	Имя расширения	МоеРасширение
ext_system_id *	Строка переменная (150)	Идентификатор во внешней системе	1234567
owner	Число (+12.0)	Код абонента владельца	1010
description	Строка переменная (100)	Наименование расширения	Мое расширение
version	Строка переменная (18)	Версия расширения	1.0.0.1
changes_data_structure	Булево	Расширение расширяет данные	true

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/extension/list_for_compare
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "sysversion": "2.0.11.10",
  "sysname": "БиблиотекаТехнологииСервиса",
  "apptype_id": "mt",
  "account": 1010,
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "extension": [
    {
      "id": "МоеРасширение",
      "ext_system_id": "1234567",
      "owner": 1010,
      "description": "Мое расширение",
      "version": "1.0.0.1",
      "changes_data_structure": true
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

extension/instances/install

Установить расширение в приложение

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
id	Строка переменная (260)	Имя расширения	МоеРасширение
tenant	Число (+7.0)	Номер приложения	1999
Ответ: general (1)
response	Число (+5.0)	Код возврата: 10200 (Запрос успешно выполнен) 10201 (Объект добавлен) 10202 (Запрос принят для обработки) 10240 (Запрос обработан с корректировкой) 10400 (Плохой запрос) 10401 (Запрос не авторизован) 10403 (Нарушение прав доступа) 10404 (Объект не найден) 10405 (Метод не поддерживается) 10406 (Неприемлемые входные данные) 10409 (Конфликт в данных) 10500 (Внутренняя ошибка) 10501 (Метод не реализован) 10520 (Неизвестная ошибка)	10202
error	Булево	Флаг ошибки. Истина означает, что при выполнении метода возникла ошибка	false
message *	Строка неограниченной длины	Описание ошибки
version	Число (+5.0)	Версия API, которая была задействована при выполнении запроса	31
sm_version	Строка переменная (18)	Версия конфигурации менеджера сервиса	1.1.39.17
sm_timezone	Строка переменная (100)	Часовой пояс информационной базы менеджера сервиса	Europe/Moscow

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/extension/instances/install
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": "МоеРасширение",
  "tenant": 1999,
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "general": {
    "response": 10202,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

extension/instances/list

Список расширений и приложений для его установки

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
id	Строка переменная (260)	Имя расширения	МоеРасширение
Ответ: instance (0..*)
tenant	Число (+7.0)	Номер приложения	2000
id	Строка переменная (260)	Имя расширения	МоеРасширение
status	Строка (перечисление)	Состояние экземпляра расширения: disabled (Отключено) during_installation (Устанавливается) during_removal (Удаляется) installation_error (Ошибка установки) installed (Установлено) installed_frame_version (Установлена каркасная версия) none () removal_error (Ошибка удаления)	installed

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/extension/instances/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": "МоеРасширение",
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "instance": [
    {
      "tenant": 2000,
      "id": "МоеРасширение",
      "status": "installed"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

extension/instances/remove

Удалить расширение из приложения

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
id	Строка переменная (260)	Имя расширения	МоеРасширение
tenant	Число (+7.0)	Номер приложения	2000
Ответ: general (1)
response	Число (+5.0)	Код возврата: 10200 (Запрос успешно выполнен) 10201 (Объект добавлен) 10202 (Запрос принят для обработки) 10240 (Запрос обработан с корректировкой) 10400 (Плохой запрос) 10401 (Запрос не авторизован) 10403 (Нарушение прав доступа) 10404 (Объект не найден) 10405 (Метод не поддерживается) 10406 (Неприемлемые входные данные) 10409 (Конфликт в данных) 10500 (Внутренняя ошибка) 10501 (Метод не реализован) 10520 (Неизвестная ошибка)	10202
error	Булево	Флаг ошибки. Истина означает, что при выполнении метода возникла ошибка	false
message *	Строка неограниченной длины	Описание ошибки
version	Число (+5.0)	Версия API, которая была задействована при выполнении запроса	31
sm_version	Строка переменная (18)	Версия конфигурации менеджера сервиса	1.1.39.17
sm_timezone	Строка переменная (100)	Часовой пояс информационной базы менеджера сервиса	Europe/Moscow

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/extension/instances/remove
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": "МоеРасширение",
  "tenant": 2000,
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "general": {
    "response": 10202,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

extension/instances/status

Статус установки расширения в приложении

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
id	Строка переменная (260)	Имя расширения	МоеРасширение
tenant	Число (+7.0)	Номер приложения	2000
Ответ: instance (1)
status	Строка (перечисление)	Состояние экземпляра расширения: disabled (Отключено) during_installation (Устанавливается) during_removal (Удаляется) installation_error (Ошибка установки) installed (Установлено) installed_frame_version (Установлена каркасная версия) none () removal_error (Ошибка удаления)	installed

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/extension/instances/status
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": "МоеРасширение",
  "tenant": 2000,
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "instance": {
    "status": "installed"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

extension/info

Информация о расширении абонента

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
id	Строка переменная (260)	Имя расширения	МоеРасширение
Ответ: extension (1)
id	Строка переменная (260)	Имя расширения	МоеРасширение
ext_system_id *	Строка переменная (150)	Идентификатор во внешней системе	1234567
owner	Число (+12.0)	Код абонента владельца	1010
description *	Строка переменная (1024)	Описание расширения	Пример описания расширения
tenant	Список (1..*)	Приложеня с возможностью установки	["1 999","2 000"]

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/extension/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": "МоеРасширение",
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "extension": {
    "id": "МоеРасширение",
    "ext_system_id": "1234567",
    "owner": 1010,
    "description": "Пример описания расширения",
    "tenant": [
      1999,
      2000
    ]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх