Разложения (Values)
Ресурс Values — распределения и подсчет записей в каталоге по выбранным критериям.
Ресурс Values доступен начиная с версии Бипиума 1.7.1. В предыдущих версиях Бипиума значения разложения можно получить через ресурс Widget/Values.

Получить разложение

Запрос
Ответ
1
URL: /{api url}/catalogs/{catalogId}/values
2
?value[type]=recordsCount
3
&axis[type]=field
4
&axis[value]=2
5
&recordsFilter[filters][0][fieldId]=12
6
&recordsFilter[filters][0][value][0]=CURRENT_USER
7
&limit=100
8
&offset=0
Copied!
Метод: GET
Параметры:
  • catalogId (string) — идентификатор каталога
Параметры фильтра (определяют выборку):
  • value[type] (string) — тип подсчитываемого значения
    • recordsCount — количество найденных записей (по умолчанию)
    • field — значение по полю каталога
  • value[value] (string) — идентификатор поля каталога для расчета. Допустимо указывать поля типов: число, прогресс, звезды, статус, набор галочек, выбор, связанный объект.
  • value[subType] (string) — подтип подсчитываемого значения
    • uniqueCount — подсчет уникальных значений (доступно для полей типа связанная запись, сотрудник, текст)
    • timeLeft — время нахождения записей в определенном значении поля (доступно для полей статус, набор галочек, выбор). Например: сколько записи были в определенных статусах.
    • timeLeft — время до момента перехода в в определенное значении поля (доступно для полей статус, набор галочек, выбор). Например: сколько прошло времени до того как записи перешли в определенный статус.
  • valueFn — применяемая функция для подсчета значений
    • '' (пусто) — не применять никакую функцию (для value[type]=recordsCount)
    • count — количество записей (значений)
    • sum — сумма значений
    • max — максимальное значение в группе
    • min — минимальное значение в группе
    • avg — среднее значение в группе (пустые значения не учитываются)
    • avgAll — среднее значение в группе (пустые значения считаются за 0)
  • axis[type] (string) — тип оси для разложения записей:
    • all — без разложения (значение по умолчанию)
    • field — разложение по полю каталога
    • createdTime — разложение по времени создания записи
  • axis[value] (string) — идентификатор поля оси разложения (для axis[type]=field)
  • axis[subType] (string) — тип группировки данных по оси (для полей типа дата)
    • hour — по часам
    • hourOfDay — по часам дня (все дни «схлопываются»)
    • day — по дням
    • dayOfWeek — по дням недели (пн—вс)
    • week — по неделям
    • weekOfYear — по неделям года (все года «схлопываются»)
    • monthOfYear — по месяцам года (все года «схлопываются»)
    • month — по месяцам
    • year — по годам
  • split[type] (string) — тип разделения (ось 2) значений внутри разложения по оси
    • возможные значения аналогичны параметру axis[type]
  • split[value] (string) — идентификатор поля оси 2 (для split[type]=field)
  • split[subType] (string) — тип группировки данных по оси 2 (для полей типа дата)
    • возможные значения аналогичны параметру axis[subType]
  • splitLimit (число) — если по оси2 вариантов разложения много, то берутся не все, а только часть их них, те которые встречаются чаще (по умолчанию 10, максимум 100)
  • sort (string) — тип сортировки полученной выборки. Для разных типов полей значение по умолчанию разное.
    • axis — сортировать по наименованию (порядку) заголовков осей.
      • Для дат — в порядке их следования
      • Для статусов, наборов галочек, выбора — в порядке указания элементов в поле каталога
      • Для текста, связанных записей, сотрудников — по наименованию
    • value — сортировать по величине значений
  • sortType (string) — направление сортировки полученной выборки
    • asc — по алфавиту / в порядке хронологии / в порядке указания в каталоге
    • desc — в обратном порядке
  • recordsType (string) — какие записи учитывать для подсчета значений
    • all — все записи каталога без проверки прав (доступно, если у сотрудника, делающего запрос есть права на просмотр всех записей каталога)
    • available — учитывать только доступные сотруднику записи каталога
  • recordsFilter (object) — фильтры для выборки записей каталога, такие как filter, sort и другие. подробнее в описании параметров получения записей.
  • limit (number) — количество возвращаемых разложений (по умолчанию 30, максимум 1000)
  • offset (number) — смещение получаемой выборки разложения относительно начала, используется для постраничного получения данных с параметром limit
Естественным языком о смысле параметров описано в статье про интерфейс графика.
Ответ: 200 OK (application/json)
Пример с наличием разложения по оси (axis):
1
[
2
{
3
"axis": "Анатолий",
4
"values": [
5
{
6
"value": "7"
7
}
8
]
9
},
10
{
11
"axis": "Виктор",
12
"values": [
13
{
14
"value": "4"
15
}
16
]
17
}
18
]
Copied!
Пример с наличием разложения по оси (axis) и оси 2 (split):
1
[
2
{
3
"axis": "Анатолий",
4
"values": [
5
{
6
"split": "1"
7
"value": "3"
8
},
9
{
10
"split": "2"
11
"value": "4"
12
}
13
]
14
},
15
{
16
"axis": "Виктор",
17
"values": [
18
{
19
"split": "2"
20
"value": "3"
21
},
22
{
23
"split": "3"
24
"value": "1"
25
}
26
]
27
}
28
]
Copied!
Параметры:
  • axis — группа распределения, значение может быть строкой или объектом (в зависимости от оси разложения)
  • values (array of objects) — набор значений
    • split — группа разделения (ось 2), значение может быть строкой или объектом (в зависимости от оси разложения)
    • value (number) — значение в группе (ось) с учетом подгруппы если есть (ось 2)

Получить одно значение разложения

Запрос
Ответ
1
URL: /{api url}/catalogs/{vatalogId}/values/{axisId}
2
?value[type]=recordsCount
3
&axis[type]=field
4
&axis[value]=2
5
&recordsFilter[filters][0][fieldId]=12
6
&recordsFilter[filters][0][value][0]=CURRENT_USER
7
&limit=100
8
&offset=0
Copied!
Метод: GET
Параметры:
  • catalogId (string) — идентификатор каталога
  • axisId (string) — идентификатор разложения по оси (axis)
Параметры фильтра (определяют выборку):
  • аналогичны параметрам запроса на получение полного разложения
Ограничение: Метод вернет значение только, если указанная ось попала в общую выборку по указанным параметрам, включая параметры limit и offset.
Ответ: 200 OK (application/json)
Пример с наличием разложения по оси (axis):
1
{
2
"axis": "Анатолий",
3
"values": [
4
{
5
"value": "7"
6
}
7
]
8
}
Copied!
Пример с наличием разложения по оси (axis) и оси 2 (split):
1
{
2
"axis": "Анатолий",
3
"values": [
4
{
5
"split": "1"
6
"value": "3"
7
},
8
{
9
"split": "2"
10
"value": "4"
11
}
12
]
13
}
Copied!
Параметры:
  • axis — группа распределения, значение может быть строкой или объектом (в зависимости от оси разложения)
  • values (array of objects) — набор значений
    • split — группа разделения (ось 2), значение может быть строкой или объектом (в зависимости от оси разложения)
    • value (number) — значение в группе (ось) с учетом подгруппы если есть (ось 2)