❗Обновление до версии 2.0
Данная инструкция обязательна к изучению в случаях, когда в системе работают автоматизации, настроены вебхуки и/или выполняются внешние взаимодействия с данными системы по API. В других случаях обновление не окажет влияния на работу системы и интеграций. В данной статье описаны ключевые аспекты обновления, по которым можно определить влияние изменений на конкретную систему.
Необратимые изменения в версии 2.0
Для облачной и серверной версий
Изменен ID служебного раздела «Управление» с числового на текстовый. Раздел теперь недоступен по числовому ID.
Изменены ID служебных каталогов («Сотрудники», «События» и др.) в разделе «Управление» с числовых на текстовые. Каталоги теперь доступны как по числовому, так и по текстовому ID.
Изменены ID полей служебных и серверных каталогов с числовых на текстовые. Ресурсы Catalogs (каталоги) и Records (записи) поддерживают работу в обоих форматах ID полей. Все другие ресурсы работают только в новом текстовом формате ID полей (возвращают данные и принимают параметры).
Для серверной версии
Изменен ID служебного раздела «Система» с числового на текстовый. Раздел больше недоступен по числовому ID.
Изменены ID серверных каталогов («Домены», «Аккаунты» и др.) в разделе «Система» с числовых на текстовые. Каталоги теперь доступны как по числовому, так и по текстовому ID.
Изменена структура БД: переименованы имена колонок во многих таблицах (подробности ниже).
Как понять, что изменения повлияют на работу системы
1. Работа с записями служебных каталогов
Если вы работаете с записями служебных каталогов по API, то в качестве ID записей и полей могут использоваться как текстовые, так и числовые ID.
[Records.Get и Records.Find]
При получении/поиске записей служебных каталогов можно указывать как текстовый, так и числовой ID каталога. Для поиска записей, в массиве фильтров в атрибутах fieldId, catalogId и recordId может указываться как текстовый, так и числовой ID. В возвращаемых данных атрибут catalogId будет указан в текстовом формате, а поля записей будут задублированы (будут в числовом и текстовом форматах).
[Records.Create и Records.Update]
При создании/изменении записей по API можно указывать как текстовые, так и числовые ID каталогов, записей и полей (в том числе и для полей связанных записей).
[Входные данные сценариев]
Во входных параметрах атрибут catalogId будет иметь текстовый формат. Поля записи в переменных values, prevValues и allValues будут задублированы (будут в числовом и текстовом форматах).
[Вебхуки]
В данных вебхуков атрибут catalogId будет иметь текстовый формат. Поля атрибутов values, prevValues и allValues будут задублированы (будут в числовом и текстовом форматах)
2. Работа с записями любых каталог со связями на служебные каталоги
Если вы используете в своих каталогах поля типа «Связанный каталог», которые ссылаются на служебные каталоги, связанные записи будут приходить с текстовыми ID каталогов.
[Records.Get и Records.Find]
При получении записей по API, в атрибуте values для полей типа «Связанный каталог», которые ссылаются на служебные каталоги, атрибуты catalogId и sectionId будут указаны в текстовом формате.
[Records.Create и Records.Update]
При создании/изменении записей можно указывать атрибут catalogId в любом формате. В возвращаемых данных catalogId будет также в текстовом формате, а поля будут задублированы.
[Входные данные сценариев]
Во входных параметрах сценариев, при создании/изменении записей в связях по служебным каталогам атрибут catalogId будет указан в текстовом формате.
[Вебхуки]
В вебхуках в связях по служебным каталогам атрибут catalogId будет указан в текстовом формате.
[Views.Get]
При получении определенного вида каталога в поле value атрибута filters для полей типа «Связанный каталог», которые ссылаются на служебные каталоги, будут указаны текстовые значения атрибута catalogId.
3. Работа со структурами любых каталогов
Если вы делаете запросы к API на получение, создание или изменение структуры каталога в сценариях или сторонних сервисах, то возвращаемые данные могут иметь задублированные поля.
[Catalogs.Get, Catalogs.Create и Catalogs.Update]
В возвращаемых данных в объекте fields для полей типа «Связанный каталог» будут перечислены текстовые ID каталогов, если эти каталоги являются служебными. В ином случае ID каталога может иметь числовое значение, если, например, оно было задано системой по-умолчанию. При этом, для служебных каталогов, будут указаны задублированные поля - в числовом и текстовом форматах.
[Catalogs.Update]
При изменении структуры каталога для поля типа «Связанный каталог» служебного каталога может указываться ID каталога в обоих форматах.