Документация Bpium

Сайт
API
Регистрация

Документация Bpium

Сайт
API
Регистрация
Powered by GitBook
Have an account? Sign in

Записи (Records)

Contents

Ресурс Record — запись с данными в каталоге.

Запись

URL: /{api url}/catalogs/{catalogId}/records/{recordId}

Параметры:

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

  • recordId: (number) — идентификатор записи

Получить запись [GET]

Ответ: 200 OK (application/json)

        {
            "id": "31007",
            "title": "Record Title",
            "privilegeCode": "access", // право на запись
            "values": {
                "2": "Record Title", // текстовое поле
                "3": 333, // число
                "4": ["1"], // категория, набор галочек, вопрос
                "8": "2015-11-06T21:00:00.000Z", // дата в 0-м часовом поясе
                "11": [{ // контакт
                        "contact": "8-901-234-56-78",
                        "comment":"основной"
                    },{
                        "contact":"8-987-654-32-10",
                        "comment":""
                }]
                "14": [{ // сотрудник
                    "id": "1",
                    "title": "Victor Nikitin"
                }],
                "15": [{ // связанный объект
                    "sectionId": "2",
                    "catalogId": "5",
                    "catalogTitle": "Clients",
                    "catalogIcon": "users-10",
                    "recordId": "33",
                    "recordTitle": "Companyname"
                }],
                "16": [{ // файл
                    "id": "5",
                    "title": "bpium_logo.png",
                    "url": "https://..."
                    "size": "8513",
                    "mimeType": "image/png",
                    "metadata": { // уменьшенные копии для изображений
                         "preview" : "https://...",
                         "thumbnail" : "https://..."
                    } 
                }]
            }
        }

Изменить запись [PATCH]

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

        {
            "values": {
                "2": "text field value",
                "4": ["2", "4"],
                "11": [{ // контакт
                        "contact": "8-901-234-56-78",
                        "comment":"основной"
                    },{
                        "contact":"8-987-654-32-10",
                        "comment":""
                }]
                "14": [{ // сотрудник
                        "id": "2"
                    },{
                        "id": "3"
                    }],
                "15": [{ // связанный объект
                        "catalogId": "5",
                        "recordId": "33"
                    },{
                        "catalogId": "5",
                        "recordId": "34"
                    }],
​
                "16": [ // файл
                    // 96, 97 файлы уже существовали и не были изменены
                    {
                        "id": "96"
                    }, {
                        "id": "97"
                    }, 
                    // прикрепить новый файл, хранящийся на стороннем сервере
                    {
                        "src": "https://link.com/image.jpg", 
                        "title": "Логотип",
                        "mimeType": "image/jpeg" // необязательный параметр
                    }
                ]
            }
        }

Ответ: 200 OK

Удалить запись [DELETE]

Ответ: 200 OK

Коллекция записей

URL: /{api url}/catalogs/{catalogId}/records
      {?viewId}
      {?filters}
      {?searchText}
      {?sortField}{?sortType}
      {?limit}{?offset}

Параметры:

  • viewId: 1 (number) — идентификатор вида каталога для фильтра записей

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

  • filters (array, опционально) — набор[] фильтров по полям

  • searchText (string, опционально) — быстрый поиск по вхождению

  • sortField: (number, опционально) — идентификатор поля для сортировки

  • sortType (enum[int], опционально) — тип сортировки

    • 1 — по возрастанию (по умолчанию)

    • -1 — по убыванию

  • limit (number, опционально) - количество возвращаемых записей (по умолчанию: 100)

  • offset (number, опционально) — смещение от начала списка (по умолчанию: 0)

Получить записи [GET]

Ответ: 200 OK (application/json)

        [
            {
                "id": "30991",
                "title": "Record title X",
                "values": {
                    "2": "Record title X",
                    "3": 333,
                    "4": ["1"],
                    "8": "2015-11-06T21:00:00.000Z",
                    "9": ["1"],
                    "10": null,
                    "14": [{
                        "id": "1",
                        "title": "Victor Nikitin"
                    }],
                    "15": [{
                        "sectionId": "2",
                        "catalogId": "5",
                        "catalogTitle": "Clients",
                        "catalogIcon": "users-10",
                        "recordId": "33",
                        "recordTitle": "Companyname 33"
                    }]
                }
            }, {
                "id": "30990",
                "title": "Record title Y",
                "values": {
                    "2": "Record title Y",
                    "3": 333,
                    "4": ["1"],
                    "8": "2015-11-06T21:00:00.000Z",
                    "9": ["1"],
                    "10": null,
                    "14": [{
                        "id": "1",
                        "title": "Victor Nikitin"
                    }],
                    "15": [{
                        "sectionId": "2",
                        "catalogId": "5",
                        "catalogTitle": "Clients",
                        "catalogIcon": "users-10",
                        "recordId": "34",
                        "recordTitle": "Companyname 34"
                    }]
                }
            }
        ]

Фильтр по полям (filters):

Пример:

http://company.bpium.ru/api/v1/catalogs/21/records
           ?limit=50
           &filters[0][fieldId]=4
           &filters[0][value][at]=2015-10-27T00:00:00+03:00
           &filters[0][value][to]=2015-11-19T23:59:59+03:00
           &filters[1][fieldId]=15
           &filters[1][value][0][catalogId]=18
           &filters[1][value][0][recordId]=9
           &filters[1][value][1][catalogId]=18
           &filters[1][value][1][recordId]=10

Filters — массив фильтров. Поэтому в GET-параметрах каждый добавленный к поисковому запросу фильтр имеет свой последовательный идентификатор: filters[№]. Каждый фильтр это объект, состоящий из параметра fieldId (указывает на ID поля для фильтрации данных) и объекта value (параметры поискового запроса). Value для разных типов полей имеет разную структуру.

  filters = [
    {
      fieldId : X,
      value : String, или {}, или [], или [ {}, ... ]
    },
    ...
  ]

Формат параметра value для разных типов полей:

  • Для текстовых полей — поиск по вхождению: [value] = ""

  • Для дат, чисел, прогресса — поиск по диапазону: [value][at] = '...', [value][to] = '...'

  • Для категории, набора галочек, вопроса, звёзд — поиск по вхождению: [value][0] = 1 & [value][1] = 2

  • Для категории и вопроса доступен также формат: [value]=[1,2,3,5]

  • Для связанных объектов: [value][0][catalogId]=18, [value][0][recordId]=9

  • Для сотрудников: [value][0]=21, [value][1]=22, [value][2]=CURRENT_USER

Создать запись [POST]

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

        {
            "values": {
                "2": "Text", // текстовое поле
                "3": 333, // число
                "4": ["1","2"], // категория, набор галочек, вопрос
                "8": "2015-11-06T21:00:00.000Z", // дата в 0-м часовом поясе
                "11": [{ // контакт
                        "contact": "8-901-234-56-78",
                        "comment":"основной"
                    },{
                        "contact":"8-987-654-32-10",
                        "comment":""
                }]
                "14": [{ // сотрудник
                    "id": "1"
                }],
                "15": [{ // связанный объект
                    "catalogId": "5",
                    "recordId": "35"
                }],
                "16": [{ // файл
                    "src": "https://link.com/voice.mp3",
                    "title": "Awesome voice",
                    "mimeType": "audio/mp3" // необязательный параметр
                }]
            }
        }

Ответ: 200 OK (application/json)

        {
            "id": "31015" // идентификатор созданной записи
        }