Каталоги (Catalogs)

Ресурс Catalog — каталог с записями.

Список каталогов

Запрос

URL: {domain}/api/v1/catalogs?sectionId={sectionId}

Метод: GET

Параметры:

• sectionId (строка) — фильтр по отделу

Ответ

Получить каталог

Запрос

URL: {domain}/api/v1/catalogs/{catalogId}
    {?fields}

Метод: GET

Параметры:

• catalogId (строка) — идентификатор каталога

• fields (json array, опционально) — набор возвращаемых полей записей, формат: ["2", "3"]. Доступно с версии API 1.9.1.

Ответ

Создать каталог

Запрос

URL: {domain}/api/v1/catalogs/

Метод: POST

Запрос: (application/json)

{
    "name": "New catalog",
    "icon": "icon",
    "sectionId": "2",
    "fields": [{
        "name": "Секция",
        "hint": "",
        "type": "group",
        "config": {}
    }, {
        "name": "Текст",
        "hint": "Подсказка к полю текст",
        "type": "text",
        "config": {
            "type": "text"
        }
    }, {
        "name": "Дата",
        "hint": "",
        "type": "date",
        "config": {
            "time": false,
            "notificationField": null
        }
    }, {
        "name": "Набор галочек",
        "hint": "",
        "type": "checkboxes",
        "config": {
            "items": [{
                "name": "1"
            }, {
                "name": "2"
            }, {
                "name": "3"
            }]
        }
    }, {
        "name": "Прогресс",
        "hint": "",
        "type": "progress",
        "config": {}
    }, {
        "name": "Сотрудник",
        "hint": "",
        "type": "user",
        "config": {
            "multiselect": false
        }
    }, {
        "name": "Связанный объект",
        "hint": "",
        "type": "object",
        "config": {
            "multiselect": false,
            "catalogs": [{
                "id": "11"
            }]
        }
    }, {
        "name": "Файл",
        "hint": "",
        "type": "file",
        "config": {
            "multiselect": false
        }
    }]
}

Возможные значения для icon описаны в документации.

Ответ

Изменить каталог

Запрос

URL: {domain}/api/v1/catalogs/{catalogId}

Метод: PATCH

Параметры:

• catalogId (строка) — идентификатор каталога

Запрос: (application/json)

{
    "name": "My catalog1",
    // если не передать параметр (например icon), то он изменен не будет
    "fields" : [
        {
            "id": "1", // чтобы сохранить существующее поле, нужно указать его id
            "name": "User",
            "type": "group"
        },
        {
            "id": "2",
            "name": "User full name", // в существующем поле можно изменить имя
            "type": "text", // тип заменить нельзя
            "config": { // в существующем поле можно изменить его параметры
                "type": "mail"
            }
        },

        // поле 3 в новом наборе полей не передали: если оно было, оно будет удалено

        // создали новое поле
        {
            "name": "Age",
            "type": "number"
        }
    ]
}

Ответ

Удалить каталог

Запрос

URL: {domain}/api/v1/catalogs/{catalogId}

Метод: DELETE

Параметры:

• catalogId (строка) — идентификатор каталога

Ответ