Infobase — действия с информационными базами 1С:Предприятия

Дата последней модификации страницы: 19.09.2024

Методы группы infobase внешнего программного интерфейса менеджера сервиса предназначены для выполнения действий информационными базами 1С:Предприятия, размещенными в облачном сервисе Фреш.

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

МетодНазначение
infobase/agent_script/createЗарегистрировать новый сценарий агента сервиса и запланировать выполнение его заданий
infobase/agent_script/listСписок сценариев агента сервиса по информационной базе
infobase/listСписок информационных баз

infobase/agent_script/create

Зарегистрировать новый сценарий агента сервиса и запланировать выполнение его заданий

ПараметрТипОписаниеПример
Запрос
cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сmt
id *Число (+9.0)Код информационной базы2
update_param *
Параметры обновления конфигурации
  - target_conf_idСтрока переменная (22)Код целевой конфигурацииmt
  - target_versionСтрока переменная (18)Номер целевой версии1.1.3.11
  - permission_code *Строка неограниченной длиныКод, разрешающий начало сеанса вопреки блокировке1433270
  - denied_fromДата и время в строке формата ISOНачало интервала блокировки сеансов для обновления01.01.2022 0:00:00
  - estimated_completion_time *Дата и время в строке формата ISOПлановое время окончания обновления01.01.2022 0:05:00
templateСтрока (перечисление)Код вида сценария агента:
  • UpdateIB (Обновление информационной базы)
UpdateIB
force *БулевоВыполнить даже при наличии предупрежденийfalse
Ответ
cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сmt
idЧисло (+9.0)Код информационной базы2
template *Строка (перечисление)Код вида сценария агента:
  • UpdateIB (Обновление информационной базы)
UpdateIB
force *БулевоВыполнить даже при наличии предупрежденийfalse
created *БулевоЗарегистрирован новый сценарийtrue
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/infobase/agent_script/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "cluster_ib_name": "mt",
  "id": 2,
  "update_param": {
    "target_conf_id": "mt",
    "target_version": "1.1.3.11",
    "permission_code": "1433270",
    "denied_from": "2022-01-01T00:00:00",
    "estimated_completion_time": "2022-01-01T00:05:00"
  },
  "template": "UpdateIB",
  "force": false
}
Пример ответа  Развернуть 
{
  "cluster_ib_name": "mt",
  "id": 2,
  "template": "UpdateIB",
  "force": false,
  "created": true,
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

infobase/agent_script/list

Список сценариев агента сервиса по информационной базе

ПараметрТипОписаниеПример
Запрос
cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сmt
id *Число (+9.0)Код информационной базы2
template *Строка (перечисление)Код вида сценария агента:
  • UpdateIB (Обновление информационной базы)
UpdateIB
done *БулевоЗадание сценария агента завершеноtrue
Ответ
cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сmt
id *Число (+9.0)Код информационной базы2
listСписок (0..*)Список сведений о сценариях агента сервиса
  - templateСтрока (перечисление)Код вида сценария агента:
  • UpdateIB (Обновление информационной базы)
UpdateIB
  - agent *Строка переменная (25)Наименование агента сервисаАгент 1
  - description *Строка неограниченной длиныОписание сценария1.1.3.11 план 28.02.2019 0:00:00
  - start *Дата и время в строке формата ISOМомент планирования заданий сценария28.02.2019 0:00:00
  - finish *Дата и время в строке формата ISOМомент завершения обработки выполненного задания сценария28.02.2019 0:15:00
  - done *БулевоЗадание сценария агента завершеноtrue
  - success *БулевоУспешное завершение задания сценария агентаtrue
  - message *Строка неограниченной длиныСообщение агента сервиса по результатам выполнения заданий сценария
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/infobase/agent_script/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "cluster_ib_name": "mt"
}
Пример ответа  Развернуть 
{
  "cluster_ib_name": "mt",
  "id": 2,
  "list": [
    {
      "template": "UpdateIB",
      "agent": "Агент 1",
      "description": "1.1.3.11 план 28.02.2019 0:00:00",
      "start": "2019-02-28T00:00:00",
      "finish": "2019-02-28T00:15:00",
      "done": true,
      "success": true,
      "message": ""
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

infobase/list

Список информационных баз

ПараметрТипОписаниеПример
Запрос
cluster_ib_name *Строка переменная (255)Имя базы в кластере 1Сmt
id *Число (+9.0)Код информационной базы2
conf_id *Строка переменная (22)Код конфигурацииmt
version *Строка переменная (18)Номер версии1.1.3.10
add_tenant *БулевоДобавлять новые приложенияtrue
block_binding *БулевоБлокировать автоматическую привязку новых приложенийfalse
usage_mode *Строка (перечисление)Режим использования:
  • Демонстрационный
  • Рабочий
Рабочий
include_tags *Массив из Строка переменная (150)Фильтр по указанному списку тегов["Обновлять в первую очередь"]
exclude_tags *Массив из Строка переменная (150)Фильтр кроме указанного списка тегов["Тестовая база"]
Ответ: list (0..*)
idЧисло (+9.0)Код информационной базы2
nameСтрока переменная (64)Наименование информационной базыРабота в модели сервиса
deletion_markБулевоПометка удаленияfalse
conf_idСтрока переменная (22)Код конфигурацииmt
versionСтрока переменная (18)Номер версии1.1.3.10
configuration_change_enabledБулевоВключена возможность изменения конфигурацииtrue
add_tenantБулевоДобавлять новые приложенияtrue
block_bindingБулевоБлокировать автоматическую привязку новых приложенийfalse
url *Строка переменная (512)Веб-адресhttp://example.com/mt
cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сmt
cluster_idСтрока переменная (9)Код кластера000000001
use_initial_dataБулевоЗаполнять новые приложения начальными даннымиfalse
min_pool *Число (+5.0)Минимум свободных приложений3
usage_modeСтрока (перечисление)Режим использования:
  • Демонстрационный
  • Рабочий
Рабочий
tagsСписок (1..*)Список тегов["Обновлять в первую очередь"]
interaction_modeСтрока (перечисление)Режим взаимодействия:
  • ИспользоватьИспользоватьБезОбменаСообщениями (Использовать без обмена сообщениями)
  • НеИспользовать (Не использовать)
Использовать
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/infobase/list
Authorization: Basic base64_encode(user:password) или Bearer access_token
Пример ответа  Развернуть 
{
  "list": [
    {
      "id": 2,
      "name": "Работа в модели сервиса",
      "deletion_mark": false,
      "conf_id": "mt",
      "version": "1.1.3.10",
      "configuration_change_enabled": true,
      "add_tenant": true,
      "block_binding": false,
      "url": "http://example.com/mt",
      "cluster_ib_name": "mt",
      "cluster_id": "000000001",
      "use_initial_data": false,
      "min_pool": 3,
      "usage_mode": "Рабочий",
      "tags": [
        "Обновлять в первую очередь"
      ],
      "interaction_mode": "Использовать"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх