UpdateSbisObject (API3) — различия между версиями
м (added Category:SBIS API3 Метод using HotCat) |
|||
(не показано 16 промежуточных версий 3 участников) | |||
Строка 1: | Строка 1: | ||
− | + | Полное имя метода: API3.UpdateSbisObject | |
− | Описание | + | ==Описание== |
+ | Метод создает или обновляет [[:Категория:SBIS API3 Объект |объекте ИС]] СБИС. | ||
− | Параметры | + | ==Алгоритим== |
− | * | + | |
− | * | + | 1. Если указан идентификатор объекта пытаемся обновить данные указанного объекта. Обновляются только те свойства которые пришли во параметрах метода. Не переданные свойства остаются без изменений. |
+ | |||
+ | 2. Если указан идентификатор, но по этому идентификатору ничего нет, либо идентификатор не указан: ищем объект по естественным ключам при помощи FindSbisObject и если находим обновляем (см.п.1) если не находим создаем. | ||
+ | |||
+ | На сервисе интеграции метод дополнительно вызывает UpdateSbisObject для всех подобъектов с данными. | ||
+ | |||
+ | Если переданных данных не достаточно для выполнения обновления / создания метод должен вернуть исключение ExtException содержащей dump достаточный для диагностики причины. | ||
+ | |||
+ | |||
+ | Результат: | ||
+ | возвращает объект содержащий идентификатор, название и список естественных ключей объекта, либо исключение (варнинг). | ||
+ | |||
+ | ==Параметры== | ||
+ | * Type – строка, тип объекта | ||
+ | * Object – json объект с данными объекта | ||
Описание доступных типов и структуры данных объектов смотрите [[:Категория:SBIS API3 Объект|в справочнике объектов API3]]. | Описание доступных типов и структуры данных объектов смотрите [[:Категория:SBIS API3 Объект|в справочнике объектов API3]]. | ||
− | Результат | + | Пример параметров метода для объекта Сотрудник: |
− | * ИдИС - | + | <source lang="json"> |
+ | |||
+ | { | ||
+ | "Type": "Сотрудник", | ||
+ | "Object": | ||
+ | { | ||
+ | "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e", | ||
+ | "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e", | ||
+ | "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e", | ||
+ | "ПодразделениеОрганизации_ИдИС": "6a185a64-2979-11e7-9bfa-3497f6377b7e" | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | |||
+ | ==Результат== | ||
+ | * ИдИС - Идентификатор объекта ИС | ||
* ИдСБИС - Идентификатор объекта СБИС | * ИдСБИС - Идентификатор объекта СБИС | ||
− | * Название - Строка | + | * Название - Представления объекта(Строка) |
* Ключ1_1 - Значение ключа 1_1 в СБИС | * Ключ1_1 - Значение ключа 1_1 в СБИС | ||
* Ключ1_2 - Значение ключа 1_2 в СБИС | * Ключ1_2 - Значение ключа 1_2 в СБИС | ||
Строка 19: | Строка 50: | ||
* Ключ3 - Значение ключа 3 в СБИС | * Ключ3 - Значение ключа 3 в СБИС | ||
− | Пример объекта | + | Пример результата для объекта Сотрудник: |
<source lang="json"> | <source lang="json"> | ||
− | |||
{ | { | ||
− | "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e", | + | "result": |
− | + | { | |
− | + | "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e", | |
− | + | "ИдСБИС": "75", | |
+ | "Название": "Иванов Иван Иванович", | ||
+ | "Ключ1_1": "2315", | ||
+ | "Ключ1_2: "155", | ||
+ | "Ключ1_3: "108" | ||
+ | } | ||
} | } | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</source> | </source> | ||
[[Категория:SBIS API3 Метод]] | [[Категория:SBIS API3 Метод]] |
Текущая версия на 08:30, 20 декабря 2019
Полное имя метода: API3.UpdateSbisObject
Содержание
Описание
Метод создает или обновляет объекте ИС СБИС.
Алгоритим
1. Если указан идентификатор объекта пытаемся обновить данные указанного объекта. Обновляются только те свойства которые пришли во параметрах метода. Не переданные свойства остаются без изменений.
2. Если указан идентификатор, но по этому идентификатору ничего нет, либо идентификатор не указан: ищем объект по естественным ключам при помощи FindSbisObject и если находим обновляем (см.п.1) если не находим создаем.
На сервисе интеграции метод дополнительно вызывает UpdateSbisObject для всех подобъектов с данными.
Если переданных данных не достаточно для выполнения обновления / создания метод должен вернуть исключение ExtException содержащей dump достаточный для диагностики причины.
Результат:
возвращает объект содержащий идентификатор, название и список естественных ключей объекта, либо исключение (варнинг).
Параметры
- Type – строка, тип объекта
- Object – json объект с данными объекта
Описание доступных типов и структуры данных объектов смотрите в справочнике объектов API3.
Пример параметров метода для объекта Сотрудник:
{
"Type": "Сотрудник",
"Object":
{
"ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
"ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
"НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
"ПодразделениеОрганизации_ИдИС": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
}
}
Результат
- ИдИС - Идентификатор объекта ИС
- ИдСБИС - Идентификатор объекта СБИС
- Название - Представления объекта(Строка)
- Ключ1_1 - Значение ключа 1_1 в СБИС
- Ключ1_2 - Значение ключа 1_2 в СБИС
- Ключ1_3 - Значение ключа 1_3 в СБИС
- Ключ2 - Значение ключа 2 в СБИС
- Ключ3 - Значение ключа 3 в СБИС
Пример результата для объекта Сотрудник:
{
"result":
{
"ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
"ИдСБИС": "75",
"Название": "Иванов Иван Иванович",
"Ключ1_1": "2315",
"Ключ1_2: "155",
"Ключ1_3: "108"
}
}