Виды (Views)
Ресурс View — вид (сохраненный фильтр) каталога.

Получить виды

Запрос
Ответ
1
URL: {domain}/api/v1/catalogs/{catalogId}/views
Copied!
Метод: GET
Параметры:
  • catalogId (number) — идентификатор каталога
Ответ: 200 OK (application/json)
1
[
2
{
3
"id": "5",
4
"name": "View with Rights",
5
"originName": "View for juniors",
6
"forRights": true
7
},
8
{
9
"id": "6",
10
"name": "My own view",
11
"forRights": false
12
}
13
]
Copied!

Получить вид

Запрос
Ответ
1
URL: {domain}/api/v1/catalogs/{catalogId}/views/{viewId}
Copied!
Метод: GET
Параметры:
  • catalogId (number) — идентификатор каталога
  • viewId (number) — идентификатор вида
Ответ: 200 OK (application/json)
1
{
2
"id": "4",
3
"name": "View public name",
4
"originName": "View name for admins",
5
"forRights": true, // true — правовой вид, false — личный вид
6
"privilegeCode": "access" // право на вид
7
"filters": [
8
{
9
"id": "101", // идентификатор условия
10
"attr": "12", // идентификатор поля каталога для фильтрации
11
"value": ["1", "2", "5"] // условия фильтрации
12
},
13
{
14
"id": "102",
15
"attr": "13",
16
"value": {
17
"at": "2015-10-27T00:00:00+03:00",
18
"to" : "2015-11-19T23:59:59+03:00"
19
}
20
}
21
]
22
}
Copied!
Filters — массив фильтров. Каждый фильтр это объект, состоящий из параметра attr (указывает на ID поля для фильтрации данных) и объекта value (параметры поискового запроса). Value для разных типов полей имеет разную структуру.
Формат параметра value для разных типов полей:
  • Для текстовых полей — поиск по вхождению: value = ""
  • Для дат, чисел, прогресса — поиск по диапазону: value = { at : '...', to : '...' }
  • Для категории, набора галочек, вопроса, звёзд — поиск по вхождению: value = [1,2,3,5]
  • Для связанных объектов: value = [ { catalogId:18, recordId:9 }, { catalogId:18, recordId:10 } ]
  • Для сотрудников: value = [21, 22, 'CURRENT_USER']

Создать вид

Запрос
Ответ
1
URL: {domain}/api/v1/catalogs/{catalogId}/views
Copied!
Метод: POST
Параметры:
  • catalogId (number) — идентификатор каталога
Запрос: (application/json)
1
{
2
"name": "View public name",
3
"originName": "View name for admins",
4
"forRights": true, // true — правовой вид, false — личный вид
5
"filters": [
6
{
7
"id": "101",
8
"attr": "12",
9
"value": ["1", "2", "5"]
10
},
11
{
12
"id": "102",
13
"attr": "13",
14
"value": {
15
"at": "2015-10-27T00:00:00+03:00",
16
"to" : "2015-11-19T23:59:59+03:00"
17
}
18
}
19
]
20
}
Copied!
Ответ: 200 OK (application/json)
1
{
2
"id": "7" // идентификатор созданного вида
3
}
Copied!

Изменить вид

Запрос
Ответ
1
URL: {domain}/api/v1/catalogs/{catalogId}/views/{viewId}
Copied!
Метод: PATCH
Параметры:
  • catalogId (number) — идентификатор каталога
  • viewId (number) — идентификатор вида
Запрос: (application/json)
1
{
2
"name": "View public name",
3
"originName": "View name for admins",
4
"forRights": true
5
}
Copied!
Ответ: 200 ОК

Удалить вид

Запрос
Ответ
1
URL: {domain}/api/v1/catalogs/{catalogId}/views/{viewId}
Copied!
Метод: DELETE
Параметры:
  • catalogId (number) — идентификатор каталога
  • viewId (number) — идентификатор вида
Ответ: 200 ОК
Last modified 1yr ago