ReadConfig (IntegrationConfig) — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
(Новая страница: « Описание: Метод создает/обновляет информацию о объекте ИС ==П…»)
 
(Параметры)
 
(не показано 7 промежуточных версий 2 участников)
Строка 1: Строка 1:
  
Описание: Метод создает/обновляет информацию о [[:Категория:SBIS API3 Объект |объекте ИС]]
+
==Описание==
 +
Метод получает с сервиса хранения настроек стандартные настройки. Если нет настроек с запрошенной версией, то возвращаются настройки с максимальной версией из существующих, но меньшая чем запрошена
 +
 
 +
Полное имя метода: IntegrationConfig.ReadConfig
  
 
==Параметры==
 
==Параметры==
* Тип – строка, тип объекта
+
* filter
* Объект json объект с данными объекта
+
** service – строка, идентификатор сервиса: Com1C83, Com1C82, Web1C, SAP, StoreHouse
 +
** sybsystem строка, идентификатор подсистемы: БУХ2, БУХ3, ЗУП2 и т.п.
 +
** version - строка, версия подсистемы начиная с которой действуют эти настройки. 1.2.34.5 приводится к числу путем добавления ведущих нулей до 4 знаков и склеивания.
 +
* ini - массив. Если не пустой, то в результате возвращаются настройки указанных типов / названий. Если пустой, то возвращаются все настройки. Если неопределен, то настройки не возвращаются (в поле data пусто).
 +
** type - строка, тип ини, возможные значения: Меню,Загрузка,  Выгрузка,  ЗагрузкаИсходящий,  ВыгрузкаВходящий, Данные, Система, ПравилаОбмена)
 +
** name - строка, название ини, например: Сотрудник, Выгрузка_СчетФактураНаАванс (не обязателен)
  
Описание доступных типов и структуры данных объектов смотрите [[:Категория:SBIS API3 Объект|в справочнике объектов API3]].
+
Пример параметров метода:
 
 
Пример параметров метода для объекта Сотрудник:
 
 
<source lang="json">
 
<source lang="json">
 +
в поле data вернуться все настройки у которых тип "Загрузка":
 +
{
 +
  "filter": {
 +
    "subsystem": "БУХ3",
 +
    "service": "Com1C83",
 +
    "version": "0003000000430029"
 +
  },
 +
  "ini": [
 +
    {
 +
      "type": "Загрузка"
 +
    }
 +
  ]
 +
}
 +
в поле data вернуться настройки у которых тип "Загрузка" и имена равны "Сотрудник", "ЧастноеЛицо":
 +
{
 +
  "filter": {
 +
    "subsystem": "БУХ3",
 +
    "service": "Com1C83",
 +
    "version": "0003000000430029"
 +
  },
 +
  "ini": [
 +
    {
 +
      "type": "Загрузка",
 +
      "name": "Сотрудник"
 +
    },
 +
    {
 +
      "type": "Загрузка",
 +
      "name": "ЧастноеЛицо"
 +
    }
 +
  ]
 +
}
  
{  
+
в поле data вернуться все существующие настройки:
  "Тип": "Сотрудник",
+
{
  "Объект":  
+
  "filter": {
  {
+
    "subsystem": "БУХ3",
      "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
+
    "service": "Com1C83",
      "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
+
    "version": "0003000000430029"
      "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
+
  },
      "ПодразделениеОрганизации_ИдИС": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
+
  "ini": []
  }
 
 
}
 
}
 
</source>
 
</source>
 
  
 
==Результат==
 
==Результат==
* ИдИС - Идентификатор объекта ИС
+
Возвращает подходящую по параметрам запись
* ИдСБИС - Идентификатор объекта СБИС
+
*@IntegrationConfig - Integer
* Название - Представления объекта(Строка)
+
*service - string
* Ключ1_1 - Значение ключа 1_1 в СБИС
+
*subsystem - string
* Ключ1_2 - Значение ключа 1_2 в СБИС
+
*name_config - string
* Ключ1_3 - Значение ключа 1_3 в СБИС
+
*version - Int64
* Ключ2 - Значение ключа 2 в СБИС
+
*update_date - Datetime
* Ключ3 - Значение ключа 3 в СБИС
+
*data - string
  
Пример результата для объекта Сотрудник:
 
<source lang="json">
 
{
 
  "result":
 
  {
 
      "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
 
      "ИдСБИС": "75",
 
      "Название": "Иванов Иван Иванович",
 
      "Ключ1_1": "2315",
 
      "Ключ1_2: "155",
 
      "Ключ1_3: "108"
 
  }
 
}
 
</source>
 
  
 
[[Категория:SBIS API3 Метод]]
 
[[Категория:SBIS API3 Метод]]

Текущая версия на 14:22, 4 октября 2018

Описание

Метод получает с сервиса хранения настроек стандартные настройки. Если нет настроек с запрошенной версией, то возвращаются настройки с максимальной версией из существующих, но меньшая чем запрошена

Полное имя метода: IntegrationConfig.ReadConfig

Параметры

  • filter
    • service – строка, идентификатор сервиса: Com1C83, Com1C82, Web1C, SAP, StoreHouse
    • sybsystem – строка, идентификатор подсистемы: БУХ2, БУХ3, ЗУП2 и т.п.
    • version - строка, версия подсистемы начиная с которой действуют эти настройки. 1.2.34.5 приводится к числу путем добавления ведущих нулей до 4 знаков и склеивания.
  • ini - массив. Если не пустой, то в результате возвращаются настройки указанных типов / названий. Если пустой, то возвращаются все настройки. Если неопределен, то настройки не возвращаются (в поле data пусто).
    • type - строка, тип ини, возможные значения: Меню,Загрузка, Выгрузка, ЗагрузкаИсходящий, ВыгрузкаВходящий, Данные, Система, ПравилаОбмена)
    • name - строка, название ини, например: Сотрудник, Выгрузка_СчетФактураНаАванс (не обязателен)

Пример параметров метода:

в поле data вернуться все настройки у которых тип "Загрузка":
{
  "filter": {
    "subsystem": "БУХ3",
    "service": "Com1C83",
    "version": "0003000000430029"
  },
  "ini": [
    {
      "type": "Загрузка"
    }
  ]
}
в поле data вернуться настройки у которых тип "Загрузка" и имена равны "Сотрудник", "ЧастноеЛицо":
{
  "filter": {
    "subsystem": "БУХ3",
    "service": "Com1C83",
    "version": "0003000000430029"
  },
  "ini": [
    {
      "type": "Загрузка",
      "name": "Сотрудник"
    },
    {
      "type": "Загрузка",
      "name": "ЧастноеЛицо"
    }
  ]
}

в поле data вернуться все существующие настройки:
{
  "filter": {
    "subsystem": "БУХ3",
    "service": "Com1C83",
    "version": "0003000000430029"
  },
  "ini": []
}

Результат

Возвращает подходящую по параметрам запись

  • @IntegrationConfig - Integer
  • service - string
  • subsystem - string
  • name_config - string
  • version - Int64
  • update_date - Datetime
  • data - string