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

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

МетодНазначение
tenant/createСоздать новое приложение
tenant/create_for_migrationСоздать приложение для миграции
tenant/create_from_data_dumpСоздать приложение из файла выгрузки данных приложения
tenant/deleteУдалить приложение
tenant/extensionsСписок расширений приложения
tenant/get_demoСоздает новое или возвращает уже созданное демо приложение. Является частично асинхронным. Пока приложение готовится, возвращается код ответа - 10202.
tenant/infoИнформация о приложении
tenant/listСписок приложений
tenant/new_nameФормирует имя для нового приложения
tenant/set_nameУстановить наименование приложения
tenant/set_timezoneУстановить часовой пояс приложения
tenant/backup/createЗапланировать создание архивной копии приложения
tenant/backup/listСписок архивных копий приложения
tenant/backup_settings/getПолучить настройки резервного копирования приложения
tenant/backup_settings/resetУстановить стандартные настроки резервного копирования приложения
tenant/backup_settings/updateУстановить настроки резервного копирования приложения
tenant/users/addПредоставить доступ пользователю к приложению
tenant/users/deleteОтменить доступ пользователя к приложению
tenant/users/listСписок пользователей, которым разрешен доступ к приложению
tenant/users/set_roleУстановить роль пользователя для работы в приложении
tenant/accountИнформация по абоненту, которому принадлежит приложение

tenant/create

Создать новое приложение

ПараметрТипОписаниеПример
Запрос
applicationСтрока переменная (22)Код вида приложенияmt
name *Строка переменная (100)Название приложенияМое приложение
timezone *Строка переменная (100)Часовой пояс приложенияEurope/Moscow
users *
Права на приложения. Если не указано, пользователям устанавливаются права по умолчанию.
  - loginСтрока переменная (50)Логин пользователяAbramov
  - role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Запуск и администрирование)
  • api (Доступ к API)
  • user (Запуск)
administrator
Ответ
tenant *
Информация о созданном приложении
  - idЧисло (+7.0)Номер приложения1998
  - urlСтрока неограниченной длиныАдрес приложенияhttp://example.com/mt/1998
  - statusСтрока (перечисление)Статус приложения:
  • converted (Конвертируется)
  • copied (Копируется)
  • decommissioned (К удалению)
  • error (Ошибка подготовки)
  • migration (Миграция приложения)
  • missing (Отсутствует)
  • new (Новое)
  • preparation (Готовится к использованию)
  • ready (Готово)
  • removed (Удалено)
  • used (Используется)
used
general
Общие поля ответа
  - 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/hs/ext_api/execute/usr/tenant/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "application": "mt",
  "name": "Мое приложение",
  "timezone": "Europe/Moscow",
  "users": [
    {
      "login": "Abramov",
      "role": "administrator"
    }
  ],
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "tenant": {
    "id": 1998,
    "url": "http://example.com/mt/1998",
    "status": "used"
  },
  "general": {
    "response": 10202,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/create_for_migration

Создать приложение для миграции

ПараметрТипОписаниеПример
Запрос
id *Число (+12.0)(не используется) Код абонента1010
applicationСтрока переменная (255)Имя вида приложенияРаботаВМоделиСервиса
versionСтрока переменная (18)Номер версии1.1.3.10
extensions *
Расширения для установки
  - idСтрока неограниченной длиныИмя расширенияМоеРасширение1
  - versionСтрока переменная (20)Версия расширения1.0.0.1
  - PlusExtVersionId *Строка переменная (36)Идентификатор версии расширения 1С:Плюс032d1f48-3486-48a4-a4a7-2f17c6efa837
  - PlusVersionId *Строка переменная (36)Идентификатор расширения 1С:Плюс53dfb6e0-7bae-4cda-af9b-84ec775d42df
nameСтрока переменная (100)Название приложенияМое приложение
timezone *Строка переменная (100)Часовой пояс приложенияEurope/Moscow
users
Список пользователей сервиса для сопоставления
  - loginСтрока переменная (50)Логин пользователяAbramov
  - role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Запуск и администрирование)
  • api (Доступ к API)
  • user (Запуск)
administrator
  - userid *Уникальный идентификаторИдентификатор пользователя базы источникаabf7c2a7-1df7-4646-9327-2866804b6ce2
Ответ
tenant *
Информация о приложении для миграции
  - idЧисло (+7.0)Номер приложения2001
  - urlСтрока неограниченной длиныАдрес приложенияhttp://example.com/mt/2001
  - loginСтрока переменная (50)Логин временного пользователяmigration
  - passwordСтрока неограниченной длиныПароль временного пользователяFg53wS1
  - statusСтрока (перечисление)Статус приложения:
  • converted (Конвертируется)
  • copied (Копируется)
  • decommissioned (К удалению)
  • error (Ошибка подготовки)
  • migration (Миграция приложения)
  • missing (Отсутствует)
  • new (Новое)
  • preparation (Готовится к использованию)
  • ready (Готово)
  • removed (Удалено)
  • used (Используется)
preparation
general
Общие поля ответа
  - 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/hs/ext_api/execute/usr/tenant/create_for_migration
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "application": "РаботаВМоделиСервиса",
  "version": "1.1.3.10",
  "extensions": [
    {
      "id": "МоеРасширение1",
      "version": "1.0.0.1",
      "PlusExtVersionId": "032d1f48-3486-48a4-a4a7-2f17c6efa837",
      "PlusVersionId": "53dfb6e0-7bae-4cda-af9b-84ec775d42df"
    }
  ],
  "name": "Мое приложение",
  "timezone": "Europe/Moscow",
  "users": [
    {
      "login": "Abramov",
      "role": "administrator",
      "userid": "abf7c2a7-1df7-4646-9327-2866804b6ce2"
    }
  ],
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "tenant": {
    "id": 2001,
    "url": "http://example.com/mt/2001",
    "login": "migration",
    "password": "Fg53wS1",
    "status": "preparation"
  },
  "general": {
    "response": 10202,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/create_from_data_dump

Создать приложение из файла выгрузки данных приложения

ПараметрТипОписаниеПример
Запрос
file_idУникальный идентификаторИдентификатор (UUID) файла данных приложения, загруженного в Менеджер сервиса.65cd1354-eda2-4425-9d1c-679f6804e318
nameСтрока переменная (100)Название приложенияМое приложение
timezone *Строка переменная (100)Часовой пояс приложенияEurope/Moscow
users
Список пользователей сервиса для сопоставления
  - loginСтрока переменная (50)Логин пользователяAbramov
  - role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Запуск и администрирование)
  • api (Доступ к API)
  • user (Запуск)
administrator
  - user_id *Уникальный идентификаторИдентификатор пользователя из файла данныхabf7c2a7-1df7-4646-9327-2866804b6ce2
extensions *
Расширения для установки
  - version_uuidУникальный идентификаторИдентификатор версии расширенияabf7c2a7-1df7-4646-9327-2866804b6ce2
  - idСтрока переменная (260)Имя расширенияМоеРасширение
  - restore_frame *БулевоУстановить каркасную версию расширенияfalse
Ответ
tenant *
Информация о созданном приложении
  - idЧисло (+7.0)Номер приложения2001
  - urlСтрока неограниченной длиныАдрес приложенияhttp://example.com/mt/2001
  - statusСтрока (перечисление)Статус приложения:
  • converted (Конвертируется)
  • copied (Копируется)
  • decommissioned (К удалению)
  • error (Ошибка подготовки)
  • migration (Миграция приложения)
  • missing (Отсутствует)
  • new (Новое)
  • preparation (Готовится к использованию)
  • ready (Готово)
  • removed (Удалено)
  • used (Используется)
preparation
general
Общие поля ответа
  - 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/hs/ext_api/execute/usr/tenant/create_from_data_dump
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "file_id": "65cd1354-eda2-4425-9d1c-679f6804e318",
  "name": "Мое приложение",
  "timezone": "Europe/Moscow",
  "users": [
    {
      "login": "Abramov",
      "role": "administrator",
      "user_id": "abf7c2a7-1df7-4646-9327-2866804b6ce2"
    }
  ],
  "extensions": [
    {
      "version_uuid": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
      "id": "МоеРасширение",
      "restore_frame": false
    }
  ],
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "tenant": {
    "id": 2001,
    "url": "http://example.com/mt/2001",
    "status": "preparation"
  },
  "general": {
    "response": 10202,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/delete

Удалить приложение

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
create_backup *БулевоСоздать архивную копию перед удалениемtrue
Ответ
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/delete
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "create_backup": true,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/extensions

Список расширений приложения

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код абонента1010
idЧисло (+7.0)Номер приложения2000
Ответ: extension (0..*)
idСтрока переменная (260)Имя расширенияМоеРасширение
statusСтрока (перечисление)Состояние экземпляра расширения:
  • disabled (Отключено)
  • during_installation (Устанавливается)
  • during_removal (Удаляется)
  • installation_error (Ошибка установки)
  • installed (Установлено)
  • installed_frame_version (Установлена каркасная версия)
  • none ()
  • removal_error (Ошибка удаления)
installed
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/extensions
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": 2000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "extension": [
    {
      "id": "МоеРасширение",
      "status": "installed"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/get_demo

Создает новое или возвращает уже созданное демо приложение. Является частично асинхронным. Пока приложение готовится, возвращается код ответа - 10202.

ПараметрТипОписаниеПример
Запрос
apptype_idСтрока переменная (22)Код вида приложенияdemo
Ответ: tenant (1)
idЧисло (+7.0)Номер приложения1998
nameСтрока переменная (100)Название приложенияДемонстрационное приложение (демо)
apptype_idСтрока переменная (22)Код вида приложенияdemo
apptype_nameСтрока переменная (255)Имя вида приложенияДемонстрационноеПриложение
apptype_presentationСтрока переменная (150)Наименование вида приложенияДемонстрационное приложение
app_versionСтрока переменная (18)Версия конфигурации2.0.14.10
urlСтрока неограниченной длиныАдрес приложенияhttp://example.com/a/demo/1998
statusСтрока (перечисление)Статус приложения:
  • converted (Конвертируется)
  • copied (Копируется)
  • decommissioned (К удалению)
  • error (Ошибка подготовки)
  • migration (Миграция приложения)
  • missing (Отсутствует)
  • new (Новое)
  • preparation (Готовится к использованию)
  • ready (Готово)
  • removed (Удалено)
  • used (Используется)
used
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/get_demo
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "apptype_id": "demo"
}
Пример ответа  Развернуть
{
  "tenant": {
    "id": 1998,
    "name": "Демонстрационное приложение (демо)",
    "apptype_id": "demo",
    "apptype_name": "ДемонстрационноеПриложение",
    "apptype_presentation": "Демонстрационное приложение",
    "app_version": "2.0.14.10",
    "url": "http://example.com/a/demo/1998",
    "status": "used"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/info

Информация о приложении

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
Ответ: tenant (1)
idЧисло (+7.0)Номер приложения2000
nameСтрока переменная (100)Название приложенияМое приложение
applicationСтрока переменная (22)Код вида приложения (устарело)mt
app_versionСтрока переменная (18)Версия конфигурации2.0.14.10
app_nameСтрока переменная (64)Наименование конфигурацииРабота в модели сервиса
apptype_idСтрока переменная (22)Код вида приложенияmt
apptype_nameСтрока переменная (255)Имя вида приложенияРаботаВМоделиСервиса
apptype_presentationСтрока переменная (150)Наименование вида приложенияРабота в модели сервиса
timezone *Строка переменная (100)Часовой пояс приложенияEurope/Moscow
ownerЧисло (+12.0)Код абонента1010
statusСтрока (перечисление)Статус приложения:
  • converted (Конвертируется)
  • copied (Копируется)
  • decommissioned (К удалению)
  • error (Ошибка подготовки)
  • migration (Миграция приложения)
  • missing (Отсутствует)
  • new (Новое)
  • preparation (Готовится к использованию)
  • ready (Готово)
  • removed (Удалено)
  • used (Используется)
used
urlСтрока неограниченной длиныАдрес приложенияhttp://example.com/mt/2000
platform *Строка переменная (18)Версия платформы 1С:Предприятие8.3.1.1
size *Число (+15.0)Размер приложения102400
size_calc_date *Дата и время в строке формата ISOДата расчета размера приложения01.12.2024 21:07:19
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "tenant": {
    "id": 2000,
    "name": "Мое приложение",
    "application": "mt",
    "app_version": "2.0.14.10",
    "app_name": "Работа в модели сервиса",
    "apptype_id": "mt",
    "apptype_name": "РаботаВМоделиСервиса",
    "apptype_presentation": "Работа в модели сервиса",
    "timezone": "Europe/Moscow",
    "owner": 1010,
    "status": "used",
    "url": "http://example.com/mt/2000",
    "platform": "8.3.1.1",
    "size": 102400,
    "size_calc_date": "2024-12-01T21:07:19"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/list

Список приложений

ПараметрТипОписаниеПример
Запрос
name *Строка переменная (100)Фильтр по наименованию приложенияМое
application *Массив из Строка переменная (22)Фильтр по коду вида приложения["smtl"]
status *Массив из Строка (перечисление)Фильтр по статусу приложения:
  • converted (Конвертируется)
  • copied (Копируется)
  • decommissioned (К удалению)
  • error (Ошибка подготовки)
  • migration (Миграция приложения)
  • missing (Отсутствует)
  • new (Новое)
  • preparation (Готовится к использованию)
  • ready (Готово)
  • removed (Удалено)
  • used (Используется)
["used"]
Ответ: tenant (1..*)
idЧисло (+7.0)Номер приложения2000
nameСтрока переменная (100)Название приложенияМое приложение
applicationСтрока переменная (22)Код вида приложения (устарело)mt
app_versionСтрока переменная (18)Версия конфигурации2.0.14.10
app_nameСтрока переменная (64)Наименование конфигурацииРабота в модели сервиса
apptype_idСтрока переменная (22)Код вида приложенияmt
apptype_nameСтрока переменная (255)Имя вида приложенияРаботаВМоделиСервиса
apptype_presentationСтрока переменная (150)Наименование вида приложенияРабота в модели сервиса
timezone *Строка переменная (100)Часовой пояс приложенияEurope/Moscow
ownerЧисло (+12.0)Код абонента1010
statusСтрока (перечисление)Статус приложения:
  • converted (Конвертируется)
  • copied (Копируется)
  • decommissioned (К удалению)
  • error (Ошибка подготовки)
  • migration (Миграция приложения)
  • missing (Отсутствует)
  • new (Новое)
  • preparation (Готовится к использованию)
  • ready (Готово)
  • removed (Удалено)
  • used (Используется)
used
urlСтрока неограниченной длиныАдрес приложенияhttp://example.com/mt/2000
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

Пример ответа  Развернуть
{
  "tenant": [
    {
      "id": 2000,
      "name": "Мое приложение",
      "application": "mt",
      "app_version": "2.0.14.10",
      "app_name": "Работа в модели сервиса",
      "apptype_id": "mt",
      "apptype_name": "РаботаВМоделиСервиса",
      "apptype_presentation": "Работа в модели сервиса",
      "timezone": "Europe/Moscow",
      "owner": 1010,
      "status": "used",
      "url": "http://example.com/mt/2000"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/new_name

Формирует имя для нового приложения

ПараметрТипОписаниеПример
Запрос
apptype_idСтрока переменная (22)Код вида приложенияmt
Ответ: name (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/new_name
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "apptype_id": "mt"
}
Пример ответа  Развернуть
{
  "name": "Мое приложение 3",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/set_name

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

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
nameСтрока переменная (100)Название приложенияМое приложение
Ответ: name (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/set_name
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "name": "Мое приложение",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/set_timezone

Установить часовой пояс приложения

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
timezoneСтрока переменная (100)Часовой пояс приложенияEurope/Moscow
Ответ: name (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/set_timezone
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "timezone": "Europe/Moscow",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/backup/create

Запланировать создание архивной копии приложения

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
planned_date *Дата и время в строке формата ISOМомент, на который необходимо запланировать создание копии28.02.2019 0:00:00
forced *БулевоУдалить все сеансы перед запуском копированияfalse
Ответ: name (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/backup/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "planned_date": "2019-02-28T00:00:00",
  "forced": false,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/backup/list

Список архивных копий приложения

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
start_date *Дата и время в строке формата ISOДата создания РК. Начальная, для отбора по периоду28.02.2019 0:00:00
end_date *Дата и время в строке формата ISOДата создания РК. Конечная, для отбора по периоду26.03.2020 0:00:00
Ответ: backup (0..*)
tenantЧисло (+7.0)Номер приложения2000
tenant_nameСтрока переменная (100)Название приложенияМое приложение
idУникальный идентификаторИдентификатор копииabf7c2a7-1df7-4646-9327-2866804b6ce2
conf_nameСтрока переменная (255)Имя конфигурации, как оно задано в конфигуратореРаботаВМоделиСервиса
app_versionСтрока переменная (18)Версия конфигурации1.1.3.10
app_nameСтрока переменная (150)Наименование вида приложенияРабота в модели сервиса
applicationСтрока переменная (22)Код вида приложенияmt
utc_timestampДата и время в строке формата ISOМомент создания (универсальное время)21.03.2019 0:00:00
timestampДата и время в строке формата ISOМомент создания (местное время)21.03.2019 3:00:00
sizeЧисло (+15.0)Размер файла12345
is_originalБулевоЭто исходный образ приложенияfalse
is_ondemandБулевоЭто копия по требованиюtrue
is_annualБулевоЭто ежегодная копияfalse
is_monthlyБулевоЭто ежемесячная копияfalse
is_dailyБулевоЭто ежедневная копияfalse
for_supportБулевоЭто копия для тех. поддержкиfalse
comment *Строка неограниченной длиныКомментарий к архивной копииКопия перед отчетным периодом
timezone *Строка переменная (100)Часовой пояс приложенияEurope/Moscow
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/backup/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "backup": [
    {
      "tenant": 2000,
      "tenant_name": "Мое приложение",
      "id": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
      "conf_name": "РаботаВМоделиСервиса",
      "app_version": "1.1.3.10",
      "app_name": "Работа в модели сервиса",
      "application": "mt",
      "utc_timestamp": "2019-03-21T00:00:00",
      "timestamp": "2019-03-21T03:00:00",
      "size": 12345,
      "is_original": false,
      "is_ondemand": true,
      "is_annual": false,
      "is_monthly": false,
      "is_daily": false,
      "for_support": false,
      "comment": "Копия перед отчетным периодом",
      "timezone": "Europe/Moscow"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/backup_settings/get

Получить настройки резервного копирования приложения

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
Ответ: settings (1)
dailyБулевоФормировать ежедневные копииtrue
monthlyБулевоФормировать ежемесячные копииtrue
annualБулевоФормировать ежегодные копииtrue
startДата в строке формата ISO (только время)Время начала формирования01.01.0001 2:00:00
completionДата в строке формата ISO (только время)Время завершения формирования01.01.0001 8:00:00
monthly_dayЧисло (+2.0)День формирования ежемесячных копий1
annual_monthЧисло (+2.0)Месяц формирования ежегодных копий1
annual_dayЧисло (+2.0)День месяца формирования ежегодных копий1
daily_countЧисло (+2.0)Количество хранимых ежедневных копий3
monthly_countЧисло (+2.0)Количество хранимых ежемесячных копий2
annual_countЧисло (+2.0)Количество хранимых ежегодных копий3
only_work_daysБулевоФормировать архивные копии только в дни работыtrue
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/backup_settings/get
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "settings": {
    "daily": true,
    "monthly": true,
    "annual": true,
    "start": "0001-01-01T02:00:00",
    "completion": "0001-01-01T08:00:00",
    "monthly_day": 1,
    "annual_month": 1,
    "annual_day": 1,
    "daily_count": 3,
    "monthly_count": 2,
    "annual_count": 3,
    "only_work_days": true
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/backup_settings/reset

Установить стандартные настроки резервного копирования приложения

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
Ответ: settings (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/backup_settings/reset
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/backup_settings/update

Установить настроки резервного копирования приложения

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
daily *БулевоФормировать ежедневные копииtrue
monthly *БулевоФормировать ежемесячные копииtrue
annual *БулевоФормировать ежегодные копииtrue
start *Дата в строке формата ISO (только время)Время начала формирования01.01.0001 2:00:00
completion *Дата в строке формата ISO (только время)Время завершения формирования01.01.0001 8:00:00
monthly_day *Число (+2.0)День формирования ежемесячных копий1
annual_month *Число (+2.0)Месяц формирования ежегодных копий1
annual_day *Число (+2.0)День месяца формирования ежегодных копий1
daily_count *Число (+2.0)Количество хранимых ежедневных копий3
monthly_count *Число (+2.0)Количество хранимых ежемесячных копий2
annual_count *Число (+2.0)Количество хранимых ежегодных копий3
only_work_days *БулевоФормировать архивные копии только в дни работыtrue
Ответ: settings (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/backup_settings/update
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "daily": true,
  "monthly": true,
  "annual": true,
  "start": "0001-01-01T02:00:00",
  "completion": "0001-01-01T08:00:00",
  "monthly_day": 1,
  "annual_month": 1,
  "annual_day": 1,
  "daily_count": 3,
  "monthly_count": 2,
  "annual_count": 3,
  "only_work_days": true,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/users/add

Предоставить доступ пользователю к приложению

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
loginСтрока переменная (50)Логин пользователяAbramov
roleСтрока (перечисление)Роль пользователя абонента:
  • administrator (Запуск и администрирование)
  • api (Доступ к API)
  • user (Запуск)
administrator
Ответ: settings (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/users/add
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "login": "Abramov",
  "role": "administrator",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/users/delete

Отменить доступ пользователя к приложению

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
loginСтрока переменная (50)Логин пользователяAbramov
Ответ: settings (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/users/delete
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "login": "Abramov",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/users/list

Список пользователей, которым разрешен доступ к приложению

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
login *Строка переменная (50)Фильтр по логину пользователяAbram
Ответ: user (0..*)
loginСтрока переменная (50)Логин пользователяAbramov
roleСтрока (перечисление)Роль пользователя абонента:
  • administrator (Запуск и администрирование)
  • api (Доступ к API)
  • user (Запуск)
administrator
setup_required *БулевоТребуется настройка прав в приложенииfalse
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/users/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "user": [
    {
      "login": "Abramov",
      "role": "administrator",
      "setup_required": false
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/users/set_role

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

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
loginСтрока переменная (50)Логин пользователяAbramov
roleСтрока (перечисление)Роль пользователя абонента:
  • administrator (Запуск и администрирование)
  • api (Доступ к API)
  • user (Запуск)
administrator
Ответ: user (0..*)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/users/set_role
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "login": "Abramov",
  "role": "administrator",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tenant/account

Информация по абоненту, которому принадлежит приложение

ПараметрТипОписаниеПример
Запрос
idЧисло (+7.0)Номер приложения2000
Ответ: account (1)
idЧисло (+12.0)Код абонента1010
nameСтрока переменная (64)Наименование абонентаКонфетпром
role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Администраторы абонента)
  • ext_administrator (Администраторы средств адаптации)
  • operator (Операторы обслуживающей организации)
  • owner (Владельцы абонента)
  • user (Пользователи абонента)
owner
uidСтрока переменная (64)Уникальный идентификатор абонента340578b0-a93b-11e9-e193-0242c0a85004
Пример запроса  Развернуть
POST https://1cfresh.com/hs/ext_api/execute/usr/tenant/account
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 2000,
  "auth": {
    "tenant": 2000,
    "key": "abf7c2a7-1df7-4646-9327-2866804b6ce2"
  }
}
Пример ответа  Развернуть
{
  "account": {
    "id": 1010,
    "name": "Конфетпром",
    "role": "owner",
    "uid": "340578b0-a93b-11e9-e193-0242c0a85004"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх