Изменения API в версии 2.31

Owned by Никитин Алексей
Last updated: мар. 20, 2023 by Эдуард Столяр
17 min read
.:` ., .,` .,. @@ @@ ;@ ,@@@@@ @, @@@@@@; @; @@@@@@+ @@@@@@@ @@` @@ @@ ;@ ;@ @@ # @, @@' `@@# @; @@# @@@ @@@` ;# @@ @@ @@ @@ ;@ @: @, @@. @@ @; @@; @@` +@+ ,@: .@; @# .@. ;@ @@` @, @@ .@+ @; @@ @@ @@ @@ @@ @@ @@ ;@ `@@@: @, @@ @@ @; @@ @@ @@ #: @@@ `@: @: ;@ ,@@@ @, @@ @@ @; @@ @@ @@ @; @@@ @@@@ ;@ +@. @, @@ :@: @; @@ .@# @@ @; `@. ,@@+ ;@ @: @, @@# @@ @; ;@@ @@ :@@ @; `@. @@ ;@ @@@:;@@ @, @@@,`#@@` @@@@@@, @@@,`'@@, @@@#:'@@; `@. ;@ ;@ .@@@@@. @, '@@@@@ @@@@@@, :@@@@@ ,@@@@@+ `@. =================================================================================================== =================================================================================================== == Release 2.31 == 11.04.2023 ===================================================================================== ViQube API v3.11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Добавлен API для обновления данных в таблицах ViQube. =================================================================================================== =================================================================================================== == Release 2.29 == 08.10.2022 ===================================================================================== ViQube API v3.10 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Добавлен API для управления правами доступа для БД. =================================================================================================== =================================================================================================== == Release 2.28 == 30.08.2022 ===================================================================================== ViQube API v3.9 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ В настройки "where" database/query добавлено поле function для указания функции даты =================================================================================================== =================================================================================================== == Release 2.27 == 21.06.2022 ===================================================================================== Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) В visApi().exportDashboard() добавился экспорт дашборда в ODP и ODS. Можно передать типы "ods" или "odp". 2) Подписка visApi.onWidgetLoadedListener() срабатывает сразу, если виджет уже отрисован. ViQube API v3.8 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Добавлены настройки sqlbackend =================================================================================================== =================================================================================================== == Release 2.26 == 12.04.2022 ===================================================================================== * Без изменений =================================================================================================== =================================================================================================== == Release 2.25 == 01.02.2022 ===================================================================================== ViQube API v3.7 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлены итоги в запрос и в ответ metadata/query 2) Добавлены итоги в запрос и в ответ metadata/rawdata/query 3) Значения "columninfos", "rowinfos" в ответе metadata/query изменены на 0 и 1 4) Добавлен параметр X-TIMEOUT в заголовок запроса Dashboard Server/Designer - JS API 1) Подписка на то, что виджет "Фильтр" открылся/закрылся /** * @param widgetGuid - guid виджета, на который хотим подписаться. * @param guid - guid подписываемого события. Используется, чтобы в памяти не накапливались подписки */ visApi().onFilterIsOpenChangedListener({widgetGuid, guid}, function (event) { // callback, что виджет фильтр открылся или закрылся. }); 2) Получить состояние открытия/закрытия виджета "Фильтр" /** * @param widgetGuid - guid виджета */ visApi().getFilterIsOpen(widgetGuid); 3) Экспорт всех данных виджета в Excel /** * @param widgetGuid - guid виджета, данные которого хотим экспортировать в Excel; */ visApi().exportAllWidgetData(widgetGuid) =================================================================================================== =================================================================================================== == Release 2.24 == 26.10.2021 ===================================================================================== Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлены подписки на завершение загрузки виджетов: visApi().onWidgetLoadedListener({widgetGuid, guid}, function () { // callback, что виджет загрузился }); visApi().onAllWidgetsLoadedListener({guid}, function () { // callback, что все виджеты загрузились }); =================================================================================================== =================================================================================================== == Release 2.23 == 31.08.2021 ===================================================================================== ViQube API v3.6 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлены типы в ответе на запрос metadata/query =================================================================================================== =================================================================================================== == Release 2.22 == 22.06.2021 ===================================================================================== ViQube API v3.5 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) В rawdata/query поле для установки фильтров стало массивом, теперь на вход принимается массив массивов фильтров и трактуется таким образом: [[filter1, filter2], [filter3, filter4]] -> (filter1 AND filter2) OR (filter3 AND filter4) Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлена функция установки фильтра по датам visApi().setDateFilterSelectedValues(widgetGuid, [new Date()]) - установка текущей даты visApi().setDateFilterSelectedValues(widgetGuid, [new Date("date")]) - единичный выбор visApi().setDateFilterSelectedValues(widgetGuid, [new Date("date"), new Date("date")]) - множественный выбор visApi().setDateFilterSelectedValues(widgetGuid, []); - для сброса значений "date" - дата в формате YYYY.MM.DD 2) Функция visApi().onSelectedValuesChangedListener теперь работает и для виджета Фильтр по датам =================================================================================================== =================================================================================================== == Release 2.20 == 20.01.2021 ===================================================================================== ViQube API v3.3 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлена информация о склейке в ответ на запрос 2) Добавлена функция COUNT_WITH_NULL в функции агрегации =================================================================================================== =================================================================================================== == Release 2.19 == 28.10.2020 ===================================================================================== ViQube API v3.2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлен путь /accessrights/settings для настройки комбинаций фильтров в правах доступа 2) В metadata/query поле для установки фильтров стало массивом, теперь на вход принимается массив массивов фильтров и трактуется таким образом: [[filter1, filter2], [filter3, filter4]] -> (filter1 AND filter2) OR (filter3 AND filter4) 3) Добавилась история в ответе на /metadata/export, и на вход в /metadata/import и в /metadata/import/validate =================================================================================================== =================================================================================================== == Release 2.18 == 31.08.2020 ===================================================================================== ViQube API v3.1 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Во все ответы добавлся заголовок X-UPDATE-TIME. Его значение - время последнего изменения данных. =================================================================================================== =================================================================================================== == Release 2.17 == 16.06.2020 ===================================================================================== ViQube API v3.1 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Новая версия API 3.1. 2) Добавились пути для импорта, валидации импорта, экспорта метаданных а) POST /metadata/import б) POST /metadata/import/validate в) POST /metadata/export Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Изменения функции visApi().getWidgetDataByGuid(widgeGuid).then(function (widgetData) {}); Теперь возвращает только те данные, которые пользователь видит на виджете Data Collection API v2.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлено получение/добавление/обновление значений атрибутов элементов групп показателей GET: /api/measuregroups/{measureGroupUniqueName}/elements PUT: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements/search GET: /api/measuregroups/{measureGroupUniqueName}/elements/details POST: /api/measuregroups/{measureGroupUniqueName}/elements/details/search =================================================================================================== =================================================================================================== == Release 2.16 == 13.04.2020 ===================================================================================== ViQube API v3.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Новая версия API 3.0. 2) DELETE /databases/{dbname}/tables/{tblname}/records - теперь можно удалить записи, если первичный ключ строка, а не только целое 3) DELETE /databases/{dbname}/query - удаляет данные из таблицы по условию 4) Все колонки теперь могут иметь значение null, поэтому из сущности column удалён флаг notnull 5) В секции /metatada/* поменялись следующие сущности: а) dimension б) attributes в) dimensionlink удалён, вместо него добавлен аналог - dimensionrole г) Добавлена сущность bindings для связи метаданных и данных в таблицах Соответственно, поменялось поведение всех путей, которые их используют 6) GET /metadata - добавились поля linkedDimensions и linkedDimensionRoles 7) GET /version - добавились дополнительные поля: branchHash, masterHash, buildDate, startDate, uptime. Поле hash удалено. Изменения поведения: 1) DateTime раньше возвращался миллисекундами, теперь ISO строка 2) POST /metadata/rawdata/query - Если раньше в ответе было 0 строк, то типы у колонок были boolean, теперь типы правильные 3) При добавлении null в колонку добавлется null (раньше добавлялось значение по умолчанию, если колонка была notnull=true) 4) При загрузке CSV значения вида "" и ,, загрузятся как null Data Collection API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлено необязательное поле 'comment' для передачи комментария в данные группы показателей в методах: PUT: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements 2) Добавлен необязательный флаг "MustUpdateComment" логического типа для указания необходимости обновления комментария ячейки данных группы показателей в методы: PUT: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements 3) Добавлено необязательное поле 'SystemInfo' для передачи системной информации в данные группы показателей в методах: PUT: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements Data Collection API v2.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлено необязательное поле 'comment' для передачи комментария в данные группы показателей в методах: PUT: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements 2) Добавлен необязательный флаг "MustUpdateComment" логического типа для указания необходимости обновления комментария ячейки данных группы показателей в методы: PUT: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements 3) Добавлено необязательное поле 'SystemInfo' для передачи системной информации в данные группы показателей в методах: PUT: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements 4) Добавлено получение комментария ячейки данных группы показателей в методах: GET: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements/search GET: /api/measuregroups/{measureGroupUniqueName}/elements/details POST: /api/measuregroups/{measureGroupUniqueName}/elements/details/search 5) Добавлено получение системной информации ячейки данных группы показателей в методах: GET: /api/measuregroups/{measureGroupUniqueName}/elements POST: /api/measuregroups/{measureGroupUniqueName}/elements/search GET: /api/measuregroups/{measureGroupUniqueName}/elements/details POST: /api/measuregroups/{measureGroupUniqueName}/elements/details/search 6) Добавлен метод изменения статуса данных формы: PUT: /api/measuregroups/{measureGroupUniqueName}/forms/{formUniqueIdentifier}/states 7) Добавлен метод получения бизнес-процессов: GET: /api/businessprocesses Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений =================================================================================================== =================================================================================================== == Release 2.15 == 19.08.2019 ===================================================================================== ViQube API v2.5 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Новая версия API 2.5. 2) POST /databases/*/query - поле «join» теперь массив 3) POST /databases/{dbname}/tables/{tblname}/records POST /databases/{dbname}/query Тип DateTime возвращается в UTC формате (пример: 2017-06-07T17:31:00Z ) ViQube Admin API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений Data Collection API v2.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений =================================================================================================== =================================================================================================== == Release 2.14 == 10.06.2019 ===================================================================================== ViQube API v2.4 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Новая версия API 2.4. 2) POST /metadata/query POST /metadata/rawdata/query POST /databases/<ID>/query Добавлен оператор "не равно" (NE) в фильтры по показателям ViQube Admin API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений Data Collection API v2.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений =================================================================================================== =================================================================================================== == Release 2.13 == 01.04.2019 ===================================================================================== ViQube API v2.3 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Новая версия API 2.3. 2) Изменилось тело для метода POST /accessrights/calculateforuser 3) Добавилась работа с NULL значениями: a) POST /databases/<ID>/query в полях where и having b) DELETE /databases/<ID>/query в поле where c) POST /metadata/query в показателях в полях rowFilters и filters d) POST /metadata/rawdata/query в поле measures e) POST /metadata/rawdata/getcount в поле measures 4) Добавлена возможность передать функцию в поле orderby в методе /databases/<ID>/query, чтобы можно было опеределить столбец для сортировки ViQube Admin API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений Data Collection API v2.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменений =================================================================================================== =================================================================================================== == Release 2.12 == 17.12.2018 ===================================================================================== ViQube API v2.2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Новая версия API 2.2. 2) Путь POST /accessrights/filters был удалён из всех версий API. Вместо него в API 2.2 появился путь POST /accessrights/calculateforuser ViQube Admin API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения Data Collection API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Добавлена функция для экспорта данных виджета в Excel: visApi().exportExcelWidgetData ================================================================================================== ================================================================================================== == Release 2.11 == 29.10.2018 ==================================================================================== ViQube API v2.1 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Новая версия API 2.1. Поддерживается обратная совместимость с версией 2.0. 2) В версии 2.1 появились пути: 1. POST /metadata/rawdata/query - Для запроса исходных данных из таблицы фактов 2. POST /metadata/rawdata/getcount - Для запроса количества записей из таблицы фактов ViQube Admin API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения Data Collection API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения ================================================================================================== ================================================================================================== == Release 2.10 == 20.08.2018 ==================================================================================== ViQube API v2.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Переход на версию API 2.0. ВНИМАНИЕ! Старые версии больше не поддерживаются! 2) Появились endpoint для управления правами доступа: GET /accessrights/roles/{rolename}/databases/{dbid} - просмотр прав на атрибуты/показатели в базе данных для конкретной роли PUT /accessrights/roles/{rolename}/databases/{dbid}/dimensions/{dmid}/attributes/{attrid} - установка прав на значения атрибута в базе данных для конкретной роли DELETE /accessrights/roles/{rolename}/databases/{dbid}/dimensions/{dmid}/attributes/{attrid} - удаление прав на значения атрибута в базе данных для конкретной роли PUT /accessrights/roles/{rolename}/databases/{dbid}/measuregroups/{mgid} - установка прав на показатели в группе показателей в базе данных для конкретной роли DELETE /accessrights/roles/{rolename}/databases/{dbid}/measuregroups/{mgid} - удаление прав на показатели в группе показателей в базе данных для конкретной роли POST /accessrights/filters - получение прав на показатели и значения атрибутов для массива ролей в базе данных DELETE /accessrights/roles - сброс всех прав на "по умолчанию" для определённых ролей 3) Во всех endpoint /metadata и /metadata/* все идентификаторы стали строковыми ViQube Admin API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения Data Collection API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения ================================================================================================== ================================================================================================== == Release 2.9 == 25.06.2018 ==================================================================================== ViQube API v1.12 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Версия API изменилась на 1.12 2) Появился endpoint /accessrights GET /accessrights возвращает настройки авторизации PUT /accessrights изменение настроек авторизации ViQube Admin API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения Data Collection API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Без изменения Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Добавился API для управления Drill Down ================================================================================================== ================================================================================================== == Release 2.8 == 14.05.2018 ==================================================================================== ViQube API v1.11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Версия API изменилась на 1.11 2) POST /expression/check - метод для проверки правильности написания формулы для расчётных показателей. 3) POST /metadata/databases/{dbid}/measuregroups/{mgid}/measures - изменилось тело создания показателей. Добавлена поддержка создания расчётных показателей. 4) GET /metadata GET /metadata/databases/{dbid}/measuregroups GET /metadata/databases/{dbid}/measuregroups/{mgid}/measures GET /metadata/databases/{dbid}/measuregroups/{mgid}/measures/{id} Добавлена поддержка создания расчётных показателей. 5) POST /metadata/query - добавлена поддержка изменения имени столбца для показателя 6) POST /metadata/query - добавлена поддержка установки фильтров на значения показателей до агрегации 7) POST /metadata/query - добавлена поддержка нескольких фильтров времени 8) POST /metadata/query - добавлена поддержка работы с фискальными атрибутами ViQube Admin API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Впервые вводится API в ViQube Admin. Версия 1.0 Возможности: - Получение списка планов загрузки - Получение информации по каждому плану - Получение информации по всем планам - Запуск/остановка плана Подробную документацию по API можно найти тут: http(s)://{your server ip}/vqadmin/swagger/ Data Collection API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Версия API не изменилась * Добавлена возможность работы с группами показателей - /measuregroup/* - Добавлены методы работы с метаданными - Получение списка групп показателей - Получение списка форм групп показателей - Добавлены методы для работы с данными - Получение данных групп показателей - Добавление данных групп показателей - Обновление данных групп показателей - Удаление данных групп показателей - Получение статуса данных форм групп показателей Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Без изменений ================================================================================================== ================================================================================================== == Release 2.7 == 26.03.2018 ==================================================================================== ViQube API v1.10 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Версия API изменилась на 1.10 2) POST /databases/{dbname}/query - появилось поле “offset” целого типа. Отвечает за смещение строк с которой возвращать результат. С комбинацией поля “limit” можно использовать для пагинации. Data Collection API v1.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Впервые вводится API в системе сбора данных. Версия 1.0 Возможности: - Получение метаданных - Получение списка измерений - Получение списка уровней - Получение списка папок - Получение вложенных папок - Получение списка элементов - Добавление элементов - С указанием Id - Без указания Id - Удаление элементов - Обновление элементов Подробную документацию по API можно найти тут: http(s)://{your server ip}/datacollection/swagger Dashboard Server/Designer - JS API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Функция visApi().onWidgetDataChangeListener(widgetGuid, callback) удалена и более не доступна для использования 2) Новая функция visApi().onFilterChangedMessage({guid: "1", filterGuid: "1" }, callback) позволяет регистрировать событие, которое будет вызываться при выборе нового значения фильтра. Функция доступна для всех виджетов, т.к. любой виджет может быть фильтром. ================================================================================================== ================================================================================================== == Release 2.6 == 12.02.2018 ==================================================================================== ViQube API v1.9 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Ничего не изменилось, актуальная версия API - 1.9 ================================================================================================== ================================================================================================== == Release 2.5 == 25.12.2017 ==================================================================================== ================================================================================================== ViQube API v1.9 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлена проверка на «целое число» и «минимальное/максимальное значение», где это было необходимо 2) Появился метод для очистки таблиц - DELETE /databases/{dbname}/tables/{tblname}/records/all 3) Изменилась структура запроса POST /metadata/query : - Улучшена проверка формата дат - Для запроса в несколько групп показателей теперь нужно делать несколько объектов в массиве "groups" - Добавлена поддержка ролевых измерений по полю "dlid" - Добавлена поддержка накопленного итога, поле "runningTotal" 4) Изменился API для работы с DimensionLink (добавлена поддержка ролевых измерений): - Можно задать название "name" - Можно установить «основную связь» "isPrimary" 5) В ViQube появились внутренние системные таблицы, которые расположены в системной БД с названием "internals". Она не видна в списке БД по API GET /databases. Из неё нельзя ничего удалить/добавить/изменить. Доступ к таблицам можно получить по API GET /databases/internals. На данный момент в ней присутствует 2 системные таблицы: календарь и таблица с рабочими днями. Их нельзя никак модифицировать. Таблицу с рабочими днями можно обновить через загрузчики (loaders) и очистить. После изменения таблицы с рабочими днями, автоматически обновлятся последний столбик в таблице календаря. Доступ на чтение из этих таблиц такой же как и у обычных таблиц. ================================================================================================== ================================================================================================== == Release 2.4 == 27.11.2017 ==================================================================================== ================================================================================================== ViQube API v1.8 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Снято ограничение на длину строковых имён сущностей 2) Добавлен путь, по которому можно узнать время последнего изменения данных/метаданных. GET /updatetime Пример тела ответа: { "updateTime": 1510052935922 } updateTime - количество милисекунд, прошедшее с 1970-01-01T00:00:00.000 ================================================================================================== ================================================================================================== == Release 2.3 == 30.10.2017 ==================================================================================== ================================================================================================== ViQube API v1.7 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Добавлено системное измерение календарь. Изменены: GET /metadata GET /metadata/databases/{dbid}/dimensions - Оно создаётся при создании базы данных с айдишником 2147483647, есть в каждой базе данных. Его нельзя редактировать/удалить/модифицировать. Нельзя редактировать/удалить/модифицировать его атрибуты. - При запросе измерений в GET /metadata, GET /metadata/databases/{dbid}/dimensions в объект измерения добавилось поле "type". Для календарного измерения его значение - "CALENDAR", для всех остальных - "REGULAR". - В ответе у календарного измерения поля "tableName" и "idColumnName" являются пустой строчкой. - При создании измерения поле "type" указывать не нужно. Все созданные измерения имею "type" - "REGULAR". Пример ответа на GET /metadata/databases/{dbid}/dimensions: [ { "name": "dim_1", "tableName": "table_1", "idColumnName": "id_1", "id": 1, "type": "REGULAR" }, { "name": "Календарь", "tableName": "", "idColumnName": "", "id": 2147483647 } ] 2) Изменение в сзязях с измерением. Изменены: GET /metadata GET /metadata/databases/{dbid}/measuregroups/{mgid}/dimensionlinks - При запросе связей с измерениямми в GET /metadata, GET /metadata/databases/{dbid}/measuregroups/{mgid}/dimensionlinks в объект связи с измерением добавлось поле "type". - Для связи с календарным измерением его значение - "CALENDAR", для всех остальных - "REGULAR". Если связь с обычным измерением - "REGULAR". - Для связи с типом "CALENDAR" дополнительно приходит поле "options" - это объект с полем "granularity". Значения "granularity" могут быть: YEAR | HALFYEAR | QUARTER | MONTH | WEEK | DAY - Для создания связи с измерением теперь ещё нужно передавать поле "type". Иесли свзяь с календарным измерением, то ещё нужно передавать "options", в которых указать нужную "granularity". - Нельзя менять тип связи. Пример: 1) Создание связи с календарным измерением с гранулярностью месяц: POST /metadata/databases/1/measuregroups/1/dimensionlinks { "dimensionId": 2147483647, "factColumnName": "column_1", "options": { "granularity": "MONTH" }, "type": "CALENDAR" } 2) Создание связи с обычным измерением: POST /metadata/databases/1/measuregroups/1/dimensionlinks { "dimensionId": 1, "factColumnName": "column_2", "type": "REGULAR" } ================================================================================================== ================================================================================================== == Release 2.2 == 02.10.2017 ==================================================================================== ================================================================================================== ViQube API v1.6 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Изменение терминологиии: cube -> database, поэтому изменились следующие пути: /metadata/cubes /metadata/cubes/* /metadata/cubes/*/daterange /metadata/cubes/*/measuregroups /metadata/cubes/*/measuregroups/* /metadata/cubes/*/measuregroups/*/measures /metadata/cubes/*/measuregroups/*/dimensions /metadata/cubes/*/measuregroups/*/measures/* /metadata/cubes/*/measuregroups/*/dimensionlinks /metadata/cubes/*/measuregroups/*/dimensionlinks/* теперь вместо них нужно использовать /metadata/databases /metadata/databases/* /metadata/databases/*/daterange /metadata/databases/*/measuregroups /metadata/databases/*/measuregroups/* /metadata/databases/*/measuregroups/*/measures /metadata/databases/*/measuregroups/*/dimensions /metadata/databases/*/measuregroups/*/measures/* /metadata/databases/*/measuregroups/*/dimensionlinks /metadata/databases/*/measuregroups/*/dimensionlinks/* 2) dimensions теперь находятся внутри database, поэтому изменились следующие пути: /metadata/dimensions /metadata/dimensions/* /metadata/dimensions/*/attributes /metadata/dimensions/*/attributes/* /metadata/dimensions/*/attributes/*/values теперь вместо них нужно использовать с указанием id databases /metadata/databases/{id}/dimensions /metadata/databases/{id}/dimensions/* /metadata/databases/{id}/dimensions/*/attributes /metadata/databases/{id}/dimensions/*/attributes/* /metadata/databases/{id}/dimensions/*/attributes/*/values 3) Изменено: GET /metadata - Поле cubes поменялось на databases - Исчезло поле dimensions - В элементах database полявилось поле dimensions 4) Изменено: POST /metadata/query - Поле cube поменялось на database - Добавлена возможность задавать онсительные даты в полях time->to и time->from