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

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

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

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

infobase/list

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

ПараметрТипОписаниеПример
Запрос
cluster_ib_name *Строка переменная (255)Имя базы в кластере 1Сsm
id *Число (+9.0)Код информационной базы1
conf_id *Строка переменная (9)Код конфигурацииsm
version *Строка переменная (18)Номер версии1.0.82.31
add_tenant *БулевоДобавлять новые приложенияНет
block_binding *БулевоБлокировать автоматическую привязку новых приложенийНет
usage_mode *Строка неограниченной длиныРежим использованияРабочий
include_tags *Строка переменная (150)Фильтр по указанному списку тегов["Пример тега"]
exclude_tags *Строка переменная (150)Фильтр кроме указанного списка тегов["Пример тега"]
Ответ
listСписок (0..*)Список сведений по информационным базам
  - cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сsm
  - idЧисло (+9.0)Код информационной базы1
  - nameСтрока переменная (64)Наименование информационной базыМенеджер сервиса, редакция 1.0
  - deletion_markБулевоПометка удаленияНет
  - conf_idСтрока переменная (9)Код конфигурацииsm
  - versionСтрока переменная (18)Номер версии1.0.82.31
  - support_enabledБулевоКонфигурация на поддержкеДа
  - add_tenantБулевоДобавлять новые приложенияНет
  - block_bindingБулевоБлокировать автоматическую привязку новых приложенийНет
  - url *Строка переменная (512)Веб-адресhttp://my-server.com/sm
  - cluster_idСтрока переменная (9)Код кластера000000001
  - use_initial_dataБулевоЗаполнять новые приложения начальными даннымиНет
  - min_pool *Число (+5.0)Минимум свободных приложений3
  - usage_modeСтрока неограниченной длиныРежим использованияРабочий
  - tagsСписок (1..*)Список тегов["Пример тега"]
  - interaction_modeСтрока неограниченной длиныРежим взаимодействия МС с информационной базой (Использовать, ИспользоватьБезОбменаСообщениями или НеИспользовать)Использовать
Пример запроса
{
"general": {
"version": 6,
"type": "srv",
"method": "infobase/list",
"debug": true
}
}
Пример ответа
{
"list": [
{
"cluster_ib_name": "sm",
"id": 1,
"name": "Менеджер сервиса, редакция 1.0",
"deletion_mark": false,
"conf_id": "sm",
"version": "1.0.82.31",
"support_enabled": true,
"add_tenant": false,
"block_binding": false,
"url": "http://my-server.com/sm",
"cluster_id": "000000001",
"use_initial_data": false,
"min_pool": 3,
"usage_mode": "Рабочий",
"tags": [
"Пример тега"
]
}
],
"general": {
"response": 10200,
"error": false,
"message": "",
"version": 6,
"sm_version": "1.0.82.31",
"sm_timezone": "Europe/Moscow"
}
}

 Вверх

infobase/agent_script/create

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

ПараметрТипОписаниеПример
Запрос
cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сsm
id *Число (+9.0)Код информационной базы1
update_param *
Параметры обновления конфигурации
– target_conf_idСтрока переменная (9)Код целевой конфигурацииsm
– target_versionСтрока переменная (18)Номер целевой версии1.0.82.32
– permission_code *Строка неограниченной длиныКод, разрешающий начало сеанса вопреки блокировке1433270
– denied_fromДата и время в строке формата ISOНачало интервала блокировки сеансов для обновления26.02.2019 13:00:00
– dynamic *БулевоИспользовать динамическое обновлениеНет
templateСтрока переменная (50)Код вида сценария агентаUpdateIB
forceБулевоВыполнить сценарий даже при наличии предупрежденийfalse
Ответ
cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сsm
idЧисло (+9.0)Код информационной базы1
template *Строка переменная (50)Код вида сценария агентаUpdateIB
created *БулевоЗарегистрирован новый сценарийДа
Пример запроса
{
"cluster_ib_name": "sm",
"id": 1,
"update_param": {
  "target_conf_id": "sm",
  "target_version": "1.0.82.32",
  "permission_code": "1433270",
  "denied_from": "2019-02-26T13:00:00",
  "dynamic": false
},
"template": "UpdateIB",
"general": {
  "version": 6,
  "type": "srv",
  "method": "infobase/agent_script/create",
  "debug": true
}
}
Пример ответа
{
"cluster_ib_name": "sm",
"id": 1,
"template": "UpdateIB",
"created": true,
"general": {
"response": 10200,
"error": false,
"message": "",
"version": 6,
"sm_version": "1.0.82.31",
"sm_timezone": "Europe/Moscow"
}
}

 Вверх

infobase/agent_script/list

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

ПараметрТипОписаниеПример
Запрос
cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сsm
id *Число (+9.0)Код информационной базы1
template *Строка переменная (50)Код вида сценария агентаUpdateIB
done *БулевоЗадание сценария агента завершеноДа
Ответ
idЧисло (+9.0)Код информационной базы1
cluster_ib_nameСтрока переменная (255)Имя базы в кластере 1Сsm
listСписок (0..*)Список сведений о сценариях агента сервиса
  - templateСтрока переменная (50)Код вида сценария агентаUpdateIB
  - agent *Строка переменная (25)Наименование агента сервисаАгент 1
  - description *Строка неограниченной длиныОписание сценарияПример описания сценария
  - start *Дата и время в строке формата ISOМомент планирования заданий сценария26.02.2019 0:00:00
  - finish *Дата и время в строке формата ISOМомент завершения обработки выполненного задания сценария26.02.2019 11:38:05
  - done *БулевоЗадание сценария агента завершеноДа
  - success *БулевоУспешное завершение задания сценария агентаДа
  - message *Строка неограниченной длиныСообщение агента сервиса по результатам выполнения заданий сценарияЭто пример сообщения от агента
Пример запроса
{
"cluster_ib_name": "sm",
"general": {
"version": 6,
"type": "srv",
"method": "infobase/agent_script/list",
"debug": true
}
}
Пример ответа
{
"id": 1,
"cluster_ib_name": "sm",
"list": [
{
"template": "UpdateIB",
"agent": "Агент 1",
"description": "Пример описания сценария",
"start": "2019-02-26T00:00:00",
"finish": "2019-02-26T11:38:05",
"done": true,
"success": true,
"message": "Это пример сообщения от агента"
}
],
"general": {
"response": 10200,
"error": false,
"message": "",
"version": 6,
"sm_version": "1.0.82.31",
"sm_timezone": "Europe/Moscow"
}
}

Вверх