8-800-505-24-05
Сайт Бипиум

❗Обновление до версии 2.0

Данная инструкция обязательна к изучению в случаях, когда в системе работают автоматизации, настроены вебхуки и/или выполняются внешние взаимодействия с данными системы по API. В других случаях обновление не окажет влияния на работу системы и интеграций. В данной статье описаны ключевые аспекты обновления, по которым можно определить влияние изменений на конкретную систему.

Необратимые изменения в версии 2.0

Для облачной и серверной версий

  1. Изменен ID служебного раздела «Управление» с числового на текстовый. Раздел теперь недоступен по числовому ID.

  2. Изменены ID служебных каталогов («Сотрудники», «События» и др.) в разделе «Управление» с числовых на текстовые. Каталоги теперь доступны как по числовому, так и по текстовому ID.

  3. Изменены ID полей служебных и серверных каталогов с числовых на текстовые. Ресурсы Catalogs (каталоги) и Records (записи) поддерживают работу в обоих форматах ID полей. Все другие ресурсы работают только в новом текстовом формате ID полей (возвращают данные и принимают параметры).

Для серверной версии

  1. Изменен ID служебного раздела «Система» с числового на текстовый. Раздел больше недоступен по числовому ID.

  2. Изменены ID серверных каталогов («Домены», «Аккаунты» и др.) в разделе «Система» с числовых на текстовые. Каталоги теперь доступны как по числовому, так и по текстовому ID.

  3. Изменена структура БД: переименованы имена колонок во многих таблицах (подробности ниже).

Как понять, что изменения повлияют на работу системы

1. Работа с записями служебных каталогов

Если вы работаете с записями служебных каталогов по API, то в качестве ID записей и полей могут использоваться как текстовые, так и числовые ID.

[Records.Get и Records.Find]

При получении/поиске записей служебных каталогов можно указывать как текстовый, так и числовой ID каталога. Для поиска записей, в массиве фильтров в атрибутах fieldId, catalogId и recordId может указываться как текстовый, так и числовой ID. В возвращаемых данных атрибут catalogId будет указан в текстовом формате, а поля записей будут задублированы (будут в числовом и текстовом форматах).

Пример: Получение записи из служебного каталога «Сотрудники»

Версия Бипиум 1.*

URL [GET]: https://[ домен ]/api/v1/catalogs/3/records 

{
    "id": "1",
    "catalogId": "3", // Числовой ID каталога «Сотрудники»
    "title": "Александр",
    "values": { // ID полей в числовом формате
        "1": "Александр",
        "2": "email@email.ru",
    },
    "chat": {
        "messagesCount": 0,
        "newMessages": false,
        "subscribe": false
    }
}

Версия Бипиум 2.0

URL [GET]: https://[домен]/api/v1/catalogs/3/records

URL [GET]: https://[домен]/api/v1/catalogs/$users/records 

{
    "id": "1",
    "catalogId": "$users", // Текстовый ID каталога «Сотрудники»
    "title": "Александр",
    "values": { // ID полей в числовом и текстовом форматах
        "1": "Александр",
        "2": "email@email.ru",
        "$name": "Александр", 
        "$email": "email@email.ru"
    },
    "chat": {
        "messagesCount": 0,
        "newMessages": false,
        "subscribe": false
    },
}

[Records.Create и Records.Update]

При создании/изменении записей по API можно указывать как текстовые, так и числовые ID каталогов, записей и полей (в том числе и для полей связанных записей).

Пример: Создание записи в служебном каталоге «Сотрудники»

Версия Бипиум 1.*

URL [POST]: https://[ домен ]/api/v1/catalogs/3/records 

{
    "values": {
        "1": "Александр",
        "2": "email@email.ru",
        "3" [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "catalogId": "3", // Числовой ID каталога «Сотрудники»
                "recordId": "7"
            }
        ]
    }
}

Версия Бипиум 2.0

URL [POST]: https://[домен]/api/v1/catalogs/3/records 

{
    "values": {
        "1": "Александр",
        "2": "email@email.ru",
        "3" [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "catalogId": "3", // Числовой ID каталога «Сотрудники»
                "recordId": "7"
            }
        ]
    }
}

URL [POST]: https://[домен]/api/v1/catalogs/$users/records 

{
    "values": {
        "$name": "Александр",
        "$email": "email@email.ru"
        "3" [ // Поле типа «Связанный каталог», которое ссылается на каталог "Сотрудники"
            {
                "catalogId": "$users", // Текстовый ID каталога «Сотрудники»
                "recordId": "7"
            }
        ]
    }
}

[Входные данные сценариев]

Во входных параметрах атрибут catalogId будет иметь текстовый формат. Поля записи в переменных values, prevValues и allValues будут задублированы (будут в числовом и текстовом форматах).

Пример: Входные данные сценариев при создании записи в служебном каталоге «Сотрудники»

Версия Бипиум 1.*

{
    "id": "1",
    "catalogId": "3", // Числовой ID каталога «Сотрудники»
    "title": "Александр",
    "allValues": { // ID полей в числовом формате
        "1": "Александр",
        "2": "email@email.ru"
    }
    "prevValues": {
        "1": "Александр",
        "2": "email@email.ru"
    },
    "values": {
        "1": "Александр",
        "2": "email@email.ru"
    }
}

Версия Бипиум 2.0

{
    "id": "1",
    "catalogId": "$users",
    "title": "Александр",
    "allValues": { // ID полей в числовом и текстовом форматах
        "1": "Александр",
        "2": "email@email.ru",
        "$name": "Александр",
        "$email": "email@email.ru"
    }
    "prevValues": {
        "1": "Александр",
        "2": "email@email.ru",
        "$name": "Александр",
        "$email": "email@email.ru"
    },
    "values": {
        "1": "Александр",
        "2": "email@email.ru",
        "$name": "Александр",
        "$email": "email@email.ru"
    }
}

[Вебхуки]

В данных вебхуков атрибут catalogId будет иметь текстовый формат. Поля атрибутов values, prevValues и allValues будут задублированы (будут в числовом и текстовом форматах)

Пример: Данные вебхуков при создании записи в служебном каталоге «Сотрудники»

Версия Бипиум 1.*

{
    "id": "2",
    "catalogId": "3", // Числовой ID каталога «Сотрудники»
    "title": "Александр",
    "allValues": { // ID полей в числовом формате
        "1": "Александр",
        "2": "email@email.ru",
    }
    "prevValues": {
        "1": "Александр",
        "2": "email@email.ru",
    },
    "values": {
        "1": "Александр",
        "2": "email@email.ru",
    }
}

Версия Бипиум 2.0

{
    "id": "2",
    "catalogId": "$users", // Текстовый ID каталога «Сотрудники»
    "title": "Александр",
    "allValues": { // ID полей в числовом и текстовом форматах
        "1": "Александр",
        "2": "email@email.ru",
        "$name": "Александр",
        "$email": "email@email.ru"
    }
    "prevValues": {
        "1": "Александр",
        "2": "email@email.ru",
        "$name": "Александр",
        "$email": "email@email.ru"
    },
    "values": {
        "1": "Александр",
        "2": "email@email.ru",
        "$name": "Александр",
        "$email": "email@email.ru"
    }
}

2. Работа с записями любых каталог со связями на служебные каталоги

Если вы используете в своих каталогах поля типа «Связанный каталог», которые ссылаются на служебные каталоги, связанные записи будут приходить с текстовыми ID каталогов.

[Records.Get и Records.Find]

При получении записей по API, в атрибуте values для полей типа «Связанный каталог», которые ссылаются на служебные каталоги, атрибуты catalogId и sectionId будут указаны в текстовом формате.

Пример: Получение записи пользовательского каталога, который имеет связь со служебным каталогом «Сотрудники»

Версия Бипиум 1.*

URL [GET]: https://[ домен ]/api/v1/catalogs/[ числовой id каталога ]/records

{
    "id": "1",
    "catalogId": "28",
    "title": "Просто текст",
    "values": {
        "2": "Просто текст",
        "3": 99,
        "4": [
            "1"
        ],
        "6": [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "sectionId": "1", // Числовой ID раздела «Управление»
                "catalogId": "3", // Числовой ID каталога «Сотрудники»
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    },
    "chat": {
        "messagesCount": 0,
        "newMessages": false,
        "subscribe": false
    }
}

Версия Бипиум 2.0

URL [GET]: https://[ домен ]/api/v1/catalogs/[ текстовый id каталога ]/records

{
    "id": "1",
    "catalogId": "28",
    "title": "Просто текст",
    "values": {
        "2": "Просто текст",
        "3": 99,
        "4": [
            "1"
        ],
        "6": [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "sectionId": "$settings", // Текстовый ID раздела «Управление»
                "catalogId": "$users", // Текстовый ID каталога «Сотрудники»
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    },
    "chat": {
        "messagesCount": 0,
        "newMessages": false,
        "subscribe": false
    }
}

[Records.Create и Records.Update]

При создании/изменении записей можно указывать атрибут catalogId в любом формате. В возвращаемых данных catalogId будет также в текстовом формате, а поля будут задублированы.

Пример: Создание записи в пользовательском каталоге, который имеет связь со служебным каталогом «Сотрудники»

Версия Бипиум 1.*

URL [POST]: https://[ домен ]/api/v1/catalogs/[ числовой id каталога ]/records

{
    "values": {
        "2": "Просто текст",
        "3": 99,
        "4" [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "catalogId": "3", // Числовой ID каталога «Сотрудники»
                "recordId": "7"
            }
        ]
    }
}

Версия Бипиум 2.0

URL [POST]: https://[ домен ]/api/v1/catalogs/[ числовой id каталога ]/records

{
    "values": {
        "2": "Просто текст",
        "3": 99,
        "4" [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "catalogId": "3", // Числовой ID каталога «Сотрудники»
                "recordId": "7"
            }
        ]
    }
}

URL [POST]: https://[домен]/api/v1/catalogs/[ текстовый id каталога ]/records 

{
    "values": {
        "2": "Александр",
        "3": "email@email.ru"
        "4" [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "catalogId": "$users", // Текстовый ID каталога «Сотрудники»
                "recordId": "7"
            }
        ]
    }
}

[Входные данные сценариев]

Во входных параметрах сценариев, при создании/изменении записей в связях по служебным каталогам атрибут catalogId будет указан в текстовом формате.

Пример: Входные данные сценариев при событии создания записи в пользовательском каталоге, который имеет связь со служебным каталогом «Сотрудники»

Версия Бипиум 1.*

{
    "id": "4",
    "catalogId": "28",
    "title": "Просто текст",
    "allValues": {
        "2": "Просто текст",
        "3": 99,
        "4": [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "sectionId": "1", // Числовой ID раздела «Управление»
                "catalogId": "3", // Числовой ID каталога «Сотрудники»
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    }
    "prevValues": {
        "2": "Просто текст",
        "3": 99,
        "4": [ 
            {
                "sectionId": "1",
                "catalogId": "3",
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    },
    "values": {
        "2": "Просто текст",
        "3": 99,
        "4": [ 
            {
                "sectionId": "1",
                "catalogId": "3",
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    }
}

Версия Бипиум 2.0

{
    "id": "4",
    "catalogId": "28",
    "title": "Просто текст",
    "allValues": {
        "2": "Просто текст",
        "3": 99,
        "4": [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудник
            {
                "sectionId": "$settings", // Текстовый ID раздела «Управление»
                "catalogId": "$users", // Текстовый ID каталога «Сотрудники»
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    }
    "prevValues": {
        "2": "Просто текст",
        "3": 99,
        "4": [ 
            {
                "sectionId": "$settings",
                "catalogId": "$users",
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    },
    "values": {
        "2": "Просто текст",
        "3": 99,
        "4": [ 
            {
                "sectionId": "$settings",
                "catalogId": "$users",
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    }
}

[Вебхуки]

В вебхуках в связях по служебным каталогам атрибут catalogId будет указан в текстовом формате.

Пример: Данные вебхуков при создании записи в пользовательском каталоге, который имеет связь со служебным каталогом «Сотрудники»

Версия Бипиум 1.*

{
    "id": "2",
    "catalogId": "28",
    "title": "Просто текст",
    "allValues": {
        "2": "Просто текст",
        "3": 99,
        "4": [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "sectionId": "1", // Числовой ID раздела «Управление»
                "catalogId": "3", // Числовой ID каталога «Сотрудники»
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    }
    "prevValues": {
        "2": "Просто текст",
        "3": 99,
        "4": [ 
            {
                "sectionId": "1",
                "catalogId": "3",
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ] 
    },
    "values": {
        "2": "Просто текст",
        "3": 99,
        "4": [
            {
                "sectionId": "1",
                "catalogId": "3",
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ] 
    }
}

Версия Бипиум 2.0

{
    "id": "2",
    "catalogId": "28",
    "title": "Просто текст",
    "allValues": {
        "2": "Просто текст",
        "3": 99,
        "4": [ // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            {
                "sectionId": "$settings", // Текстовый ID раздела «Управление»
                "catalogId": "$users", // Текстовый ID каталога «Сотрудники»
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ]
    }
    "prevValues": {
        "2": "Просто текст",
        "3": 99,
        "4": [
            {
                "sectionId": "$settings",
                "catalogId": "$users",
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ] 
    },
    "values": {
        "2": "Просто текст",
        "3": 99,
        "4": [
            {
                "sectionId": "$settings",
                "catalogId": "$users",
                "catalogTitle": "Сотрудники",
                "catalogIcon": "users-1",
                "recordId": "1",
                "recordTitle": "Александр",
                "isRemoved": false
            }
        ] 
    }
}

[Views.Get]

При получении определенного вида каталога в поле value атрибута filters для полей типа «Связанный каталог», которые ссылаются на служебные каталоги, будут указаны текстовые значения атрибута catalogId.

Пример: Получение вида каталога, который имеет связь со служебным каталогом «Сотрудники»

Версия Бипиум 1.*

URL [GET]: https://[ домен ]/api/v1/catalogs/[ id каталога ]/views/[ id вида ]

{
  [
    {
        "id": "20",
        "catalogId": "127",
        "catalogTitle": "Тестовый каталог",
        "catalogIcon": "content-11",
        "name": "Мои записи",
        "forRights": true,
        "originName": "Мои записи",
        "privilegesApi": {
            "value": [
                "admin",
                "access",
                "delete",
                "export",
                "create",
                "edit",
                "view",
                "search",
                "available"
            ]
        },
        "privilegeCode": "admin",
        "filters": [
            {
                "id": "30",
                "fieldId": "3",
                "value": [
                    {
                        "catalogId": "3", // Числовой ID каталога «Сотрудники»
                        "recordTitle": "Александр",
                        "recordId": "3",
                        "catalogIcon": "users-1",
                        "catalogDbId": 3,
                        "recordDbId": 3
                    }
                ]
            }
        ]
    }
]

Версия Бипиум 2.0

{
  [
    {
        "id": "20",
        "catalogId": "127",
        "catalogTitle": "Тестовый каталог",
        "catalogIcon": "content-11",
        "name": "Мои записи",
        "forRights": true,
        "originName": "Мои записи",
        "privilegesApi": {
            "value": [
                "admin",
                "access",
                "delete",
                "export",
                "create",
                "edit",
                "view",
                "search",
                "available"
            ]
        },
        "privilegeCode": "admin",
        "filters": [
            {
                "id": "30",
                "fieldId": "3",
                "value": [
                    {
                        "catalogId": "$users", // Текстовый ID каталога «Сотрудники»
                        "recordTitle": "Александр",
                        "recordId": "3",
                        "catalogIcon": "users-1",
                        "catalogDbId": 3,
                        "recordDbId": 3
                    }
                ]
            }
        ]
    }
]

3. Работа со структурами любых каталогов

Если вы делаете запросы к API на получение, создание или изменение структуры каталога в сценариях или сторонних сервисах, то возвращаемые данные могут иметь задублированные поля.

[Catalogs.Get, Catalogs.Create и Catalogs.Update]

В возвращаемых данных в объекте fields для полей типа «Связанный каталог» будут перечислены текстовые ID каталогов, если эти каталоги являются служебными. В ином случае ID каталога может иметь числовое значение, если, например, оно было задано системой по-умолчанию. При этом, для служебных каталогов, будут указаны задублированные поля - в числовом и текстовом форматах.

Пример: Получение структуры пользовательского каталога, который имеет связь со служебным каталогом «Сотрудники»

Версия Бипиум 1.*

URL [GET]: https://[ домен ]/api/v1/catalogs/[ числовой id каталога ] 

{
    "id": "141",
    "sectionId": "2",
    "icon": "content-11",
    "chat": {
        "newChats": 0
    },
    "name": "Каталог",
    "history": true,
    "fields": [
        {
            "id": "4", // Поле типа «Связанный каталог», которое ссылается на каталог «Сотрудники»
            "name": "Сотрудник",
            "required": false,
            "type": "object",
            "hint": "",
            "isSystem": false,
            "history": true,
            "filterable": true,
            "apiOnly": false,
            "comment": "",
            "config": {
                "multiselect": false,
                "accessOnly": false,
                "enableCreate": true,
                "enableUnsaved": false,
                "enableSelect": true,
                "mode": "cards",
                "defaultEmptyValue": [],
                "type": "object",
                "catalogs": [
                    {
                        "id": "3", // Числовой ID каталога
                        "title": "Сотрудники",
                        "icon": "users-1",
                        "removed": false
                    }
                ],
                "views": [],
                "fields": {
                    "3": [ // Числовой ID каталога
                        {
                            "id": "3", // Числовой ID каталога
                            "name": "Имя",
                            "columnName": "name",
                            "required": false,
                            "type": "text",
                            "hint": "",
                            "position": 1,
                            "isSystem": true,
                            "history": true,
                            "filterable": true,
                            "apiOnly": false,
                            "comment": "",
                            "config": {
                                "type": "text",
                                "mask": ""
                            },
                            "visible": {},
                            "createdAt": "2023-11-13T07:57:03.782Z",
                            "updatedAt": "2023-11-13T07:57:03.782Z",
                            "_catalogId": "3"
                        },
                        {
                            "id": "2", // Числовой ID каталога
                            "name": "Эл. почта",
                            "columnName": "email",
                            "required": false,
                            "type": "text",
                            "hint": "На указанный адрес будет отправлено приглашение на вход в систему",
                            "position": 2,
                            "isSystem": true,
                            "history": true,
                            "filterable": true,
                            "apiOnly": false,
                            "comment": "",
                            "config": {
                                "type": "mail",
                                "mask": ""
                            },
                            "visible": {},
                            "createdAt": "2023-11-13T07:57:03.782Z",
                            "updatedAt": "2023-11-13T07:57:03.782Z",
                            "_catalogId": "3"
                        }
                    ]
                }
            },
            "visible": {}
        }
    ],
    "privilegeCode": "admin",
    "fieldPrivilegeCodes": {}
}

Версия Бипиум 2.0

URL [GET]: https://[ домен ]/api/v1/catalogs/[ числовой или текстовый id каталога ] 

{
    "id": "141",
    "sectionId": "2",
    "icon": "content-11",
    "chat": {
        "newChats": 0
    },
    "name": "Каталог",
    "history": true,
    "fields": [
        {
            "id": "4", // Поле типа "Связанный каталог", которое ссылается на каталог «Сотрудники»
            "prevId": "4",
            "duplicateResultWithPrevId": false,
            "name": "Сотрудник",
            "required": false,
            "type": "object",
            "hint": "",
            "isSystem": false,
            "history": true,
            "filterable": true,
            "apiOnly": false,
            "comment": "",
            "config": {
                "multiselect": false,
                "accessOnly": false,
                "enableCreate": true,
                "enableUnsaved": false,
                "enableSelect": true,
                "mode": "cards",
                "defaultEmptyValue": [],
                "type": "object",
                "catalogs": [
                    {
                        "dbId": 3,
                        "id": "$users", // Текстовый id каталога
                        "title": "Сотрудники",
                        "icon": "users-1",
                        "removed": false
                    }
                ],
                "views": [],
                "fields": {
                    "$users": [ // Текстовый ID каталога
                        {
                            "dbId": 1,
                            "id": "$name", // Текстовый ID поля
                            "prevId": "1",
                            "name": "Имя",
                            "columnName": "name",
                            "required": false,
                            "type": "text",
                            "hint": "",
                            "position": 1,
                            "isSystem": true,
                            "history": true,
                            "filterable": true,
                            "apiOnly": false,
                            "duplicateResultWithPrevId": true,
                            "comment": "",
                            "config": {
                                "type": "text",
                                "mask": ""
                            },
                            "visible": {},
                            "createdAt": "2023-11-13T07:57:03.782Z",
                            "updatedAt": "2023-11-13T07:57:03.782Z",
                            "_catalogId": "$users"
                        },
                        {
                            "dbId": 2,
                            "id": "$email", // Текстовый id поля
                            "prevId": "2",
                            "name": "Эл. почта",
                            "columnName": "email",
                            "required": false,
                            "type": "text",
                            "hint": "На указанный адрес будет отправлено приглашение на вход в систему",
                            "position": 2,
                            "isSystem": true,
                            "history": true,
                            "filterable": true,
                            "apiOnly": false,
                            "duplicateResultWithPrevId": true,
                            "comment": "",
                            "config": {
                                "type": "mail",
                                "mask": ""
                            },
                            "visible": {},
                            "createdAt": "2023-11-13T07:57:03.782Z",
                            "updatedAt": "2023-11-13T07:57:03.782Z",
                            "_catalogId": "$users"
                        }
                    ]
                }
            },
            "visible": {}
        }
    ],
    "privilegeCode": "admin",
    "fieldPrivilegeCodes": {}
}

[Catalogs.Update]

При изменении структуры каталога для поля типа «Связанный каталог» служебного каталога может указываться ID каталога в обоих форматах.

Пример: Изменение структуры пользовательского каталога, который имеет связь со служебным каталогом «Сотрудники»

Версия Бипиум 1.*

URL [PATCH]: https://[ домен ]/api/v1/catalogs/[ числовой id каталога ] 

{
    "name": "Название каталога",
    "fields": [
        {
            "id": "4",
            "name": "Служебные каталоги",
            "type": "object",
            "config": {
                "multiselect": false,
                "mode": "cards",
                "type": "object",
                "catalogs": [
                    {
                        "id": "3" // Числовой ID каталога «Сотрудники»
                    },
                    {
                        "id": "7" // Числовой ID каталога «События»
                    }
                ]
            }
        }
    ]
}

Версия Бипиум 2.0

URL [PATCH]: https://[ домен ]/api/v1/catalogs/[ числовой или текстовый id каталога ] 

{   
    "fields": [
        {
            "id": "4",
            "name": "Служебные каталоги"