Для настройки интеграции справочников с другими системами/приложениями используйте дополнительные значения в пользовательских справочниках:
- Добавьте в справочник значение в виде JSON-объекта, который содержит массив Key — Value:
- Максимальная длина для Key: 64
- Максимальная длина для Value: 128
- Значения в Key – регистронезависимые
...
"Fields": {
"Key1": "Value1",
"Key2": "Value2",
...
}- Для изменения ограничения на максимальное количество дополнительных атрибутов в разрезе каждой записи в файле appsettings.json задайте значение параметра DictionaryItemFieldMaxCount (int), значение по умолчанию (если не указано в конфигурационного файле) — 5.
- Добавление дополнительных значений доступно для следующих системных справочников:
- Валюта
- Тип документа
- Тип события
- Организационно-правовая форма
При запросе на просмотр значений справочника через API (GET) доступно отфильтровать получаемые значения справочника по комбинации Key-Value:
- Если указывается несколько фильтров, поиск выполняется по логическому И.
- Если по одному ключу передано несколько значение, поиск выполняется по логическому ИЛИ.
При получении значений справочника Field-данные передаются только в приватном API. Поиск доступен как и в пользовательских, так и в системных справочниках. При поиске по Key-Value ищется точное совпадение. Поиск значений по Field реализован только для приватного API (POST).
При получении значений справочника через API в ответе отображаются все JSON-объекты, если они добавлены к значениям справочника. При добавлении/редактировании значения справочника через API можно добавить дополнительный параметр в JSON (не обязательный параметр):
- Если у значения не указаны параметры, или передан Fields: null, дополнительные атрибуты остаются прежними;
- Если у значения передан Fields:{}, дополнительные атрибуты у значения справочника удаляются;
- Если у значения справочника в Fields передан массив Key-Value, в результате операции остаются только переданные значения.
Запись Field-данных доступна только для приватного API.