FindSbisObject (API3) — различия между версиями
м (Разговоров Михаил переименовал страницу ВИ3.НайтиОбъект в НайтиОбъект (ВИ3) без оставления перенаправления) |
|||
(не показано 12 промежуточных версий 3 участников) | |||
Строка 1: | Строка 1: | ||
− | + | Полное имя метода: API3.FindSbisObject | |
− | + | ==Описание== | |
+ | Каждый объект может иметь три естественных ключа, два простых (одно свойство) и один составной (пять свойств в ключе), в идеале естественные ключи должны быть уникальными, однако, это не является обязательным. | ||
− | ===Параметры | + | Метод ищет объект по естественным ключам, возвращает массив найденных объектов. Поиск осуществляется по всем ключам. Результат сортируется по весу ключа. |
− | * | + | |
− | * | + | ==Алгоритм== |
+ | |||
+ | |||
+ | 1. Если передан идентификатор проверяем наличие объекта с указанным идентификатором. | ||
+ | |||
+ | 2. Если идентификатор не передан либо объекта с указанным идентификатором не существует - осуществляем последовательный поиск по переданным естественным ключам. | ||
+ | |||
+ | 3. Найденные записи объединяются по идентификатору и сортируются по весу ключей. Вес ключа зависит от объекта. Если один и тот же объект найден по разным ключам итоговый вес записи суммируется из весов ключей. | ||
+ | |||
+ | 4. Если ничего не найдено в результате возвращается пустой массив. | ||
+ | |||
+ | ==Параметры== | ||
+ | * Type – тип объекта | ||
+ | * Filter | ||
** ИдИС - идентификатор ИС | ** ИдИС - идентификатор ИС | ||
** ИдСБИС - идентификатор СБИС | ** ИдСБИС - идентификатор СБИС | ||
+ | ** Название - Представление объекта ИС | ||
** Ключ1_1 - естественный ключ 1_1 | ** Ключ1_1 - естественный ключ 1_1 | ||
** Ключ1_2 - естественный ключ 1_2 | ** Ключ1_2 - естественный ключ 1_2 | ||
** Ключ1_3 - естественный ключ 1_3 | ** Ключ1_3 - естественный ключ 1_3 | ||
+ | ** Ключ1_4 - естественный ключ 1_4 | ||
+ | ** Ключ1_5 - естественный ключ 1_5 | ||
** Ключ2 - естественный ключ 2 | ** Ключ2 - естественный ключ 2 | ||
** Ключ3 - естественный ключ 3 | ** Ключ3 - естественный ключ 3 | ||
− | + | ==Результат== | |
Метод возвращаем массив подходящих объектов, или пустой массив | Метод возвращаем массив подходящих объектов, или пустой массив | ||
Строка 23: | Строка 40: | ||
* Ключ1_2 - естественный ключ 1_2 (Строка) | * Ключ1_2 - естественный ключ 1_2 (Строка) | ||
* Ключ1_3 - естественный ключ 1_3 (Строка) | * Ключ1_3 - естественный ключ 1_3 (Строка) | ||
+ | * Ключ1_4 - естественный ключ 1_4 (Строка) | ||
+ | * Ключ1_5 - естественный ключ 1_5 (Строка) | ||
* Ключ2 - естественный ключ 2 (Строка) | * Ключ2 - естественный ключ 2 (Строка) | ||
* Ключ3 - естественный ключ 3 (Строка) | * Ключ3 - естественный ключ 3 (Строка) | ||
Строка 40: | Строка 59: | ||
{ | { | ||
"ИдИC": "а12321а3422314", | "ИдИC": "а12321а3422314", | ||
− | "ИдСБИС": " | + | "ИдСБИС": "2316", |
"Название": "Иванов Иван Петрович", | "Название": "Иванов Иван Петрович", | ||
"Ключ1_1": "22", | "Ключ1_1": "22", | ||
"Ключ1_2": "176", | "Ключ1_2": "176", | ||
− | } | + | } |
+ | ] | ||
} | } |
Текущая версия на 08:31, 20 декабря 2019
Полное имя метода: API3.FindSbisObject
Содержание
Описание
Каждый объект может иметь три естественных ключа, два простых (одно свойство) и один составной (пять свойств в ключе), в идеале естественные ключи должны быть уникальными, однако, это не является обязательным.
Метод ищет объект по естественным ключам, возвращает массив найденных объектов. Поиск осуществляется по всем ключам. Результат сортируется по весу ключа.
Алгоритм
1. Если передан идентификатор проверяем наличие объекта с указанным идентификатором.
2. Если идентификатор не передан либо объекта с указанным идентификатором не существует - осуществляем последовательный поиск по переданным естественным ключам.
3. Найденные записи объединяются по идентификатору и сортируются по весу ключей. Вес ключа зависит от объекта. Если один и тот же объект найден по разным ключам итоговый вес записи суммируется из весов ключей.
4. Если ничего не найдено в результате возвращается пустой массив.
Параметры
- Type – тип объекта
- Filter
- ИдИС - идентификатор ИС
- ИдСБИС - идентификатор СБИС
- Название - Представление объекта ИС
- Ключ1_1 - естественный ключ 1_1
- Ключ1_2 - естественный ключ 1_2
- Ключ1_3 - естественный ключ 1_3
- Ключ1_4 - естественный ключ 1_4
- Ключ1_5 - естественный ключ 1_5
- Ключ2 - естественный ключ 2
- Ключ3 - естественный ключ 3
Результат
Метод возвращаем массив подходящих объектов, или пустой массив
- ИдИС - идентификатор ИС (Строка)
- ИдСБИС - идентификатор СБИС (Строка)
- Название * - Представление объекта(Строка)
- Ключ1_1 - естественный ключ 1_1 (Строка)
- Ключ1_2 - естественный ключ 1_2 (Строка)
- Ключ1_3 - естественный ключ 1_3 (Строка)
- Ключ1_4 - естественный ключ 1_4 (Строка)
- Ключ1_5 - естественный ключ 1_5 (Строка)
- Ключ2 - естественный ключ 2 (Строка)
- Ключ3 - естественный ключ 3 (Строка)
Пример результата для объекта Сотрудник:
{
"result":
[
{
"ИдИC": "а12321а3422315",
"ИдСБИС": "2315",
"Название": "Иванов Иван Иваныч",
"Ключ1_1": "21",
"Ключ1_2": "175",
},
{
"ИдИC": "а12321а3422314",
"ИдСБИС": "2316",
"Название": "Иванов Иван Петрович",
"Ключ1_1": "22",
"Ключ1_2": "176",
}
]
}