Skip to content

Интерфейс обновления данных

в общих чертах

выпускает

Версия сервера FineBIФункциональные изменения
6.0-

Введение функции

В этой статье рассказывается об интерфейсах, связанных с обновлением данных в FineBI 6.0.

Запуск глобального обновления

Профиль интерфейса

роль интерфейсаЗапуск глобального обновления
URL-адрес интерфейса/v5/api/conf/update/generate
Тип запросаПОЛУЧИТЬ
предостережениеЧтобы вызвать обновление, для соответствующего содержимого должна существовать задача обновления.

Пример****ответа

Пример запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/conf/update/generate?fine_auth_token=xxxПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"taskInstanceId": "6d161bcd-5070-4687-a44c-81b979eb37e3","failBeans": []},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Запуск обновлений отдельных таблиц/папок

Профиль интерфейса

роль интерфейсаОбновление одной таблицы/папки на основе названий выходов из таблиц.
URL-адрес интерфейса/v5/api/conf/update/pack/table
Тип запросаПОЛУЧИТЬ
предостережениеЧтобы вызвать обновление, для соответствующего содержимого должна существовать задача обновления.

Параметры запроса - Параметры запроса

имя параметразначение параметраТребуется или нетОписание
информация{ "packageId": "folderId", "tableName": "имя таблицы", "fullLoad": "false"}.Примечание: Значения параметров представлены в формате JSON и должны быть закодированы при использовании функции encodeURIComponent().быть1) Идентификатор папки:2) Табличные переходные имена:Имя выхода таблицы - это имя таблицы, которое отображается в подготовке данных.3) полная загрузка:false: инкрементное обновлениеправда: полное обновлениеНе заполнено: по умолчанию равно true

Пример ответа

Пример запросаПредварительное кодирование значений параметров:{ "packageId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "tableName": "Enrolment table by province", "fullLoad" : "true"}Значения параметров посткодирования:%7B%22packageId%22%3A%226fb11e7b1e6e4ff3bcb907a5747527b0%22%2C%22tableName%22%3A%22%E5%90%84%E7%9C%81%E6%8B%9B%E7%94%9F%E4%BA%BA%. E6%95%B0%E8%A1%A8%22%2C%22fullLoad%22%3A%22true%22%7D**Ссылка:**http://172.17.0.25:37799/webroot/decision/v5/api/conf/update/pack/table?info=%7B%22packageId%22%3A% 226fb11e7b1e6e4ff3bcb907a5747527b0%22%2C%22tableName%22%3A%22%E5%90%84%E7%9C%81%E6%8B%9B%E7%94%9F%E4%BA%BA%E6%95%B0%E8%A1%A8%22%22 2C%22fullLoad%22%3A%22true%22%7D&fine_auth_token=xxxПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"taskInstanceId": "d9e9eb1d-d88c-482a-8af1-8823d1b1cfd0","failBeans": []},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Запуск массовых обновлений

Профиль интерфейса

роль интерфейсаПакетное обновление на основе идентификатора папки.
URL-адрес интерфейса/v5/api/conf/update/batch
Тип запросаПОСТ
предостережениеЧтобы вызвать обновление, для соответствующего содержимого должна существовать задача обновления.

Параметры запроса - Параметры тела

телоТребуется или нетОписание
[{"packageId": "folderId"."fullLoad":false}]быть1) Идентификатор папки:2) полная загрузка:false: инкрементное обновлениеистина: полное обновлениеНе заполнено: по умолчанию равно true

Пример ответа

Ссылка для запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/conf/update/batch?fine_auth_token=xxxПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Тело запроса[{"packageId":"6fb11e7b1e6e4ff3bcb907a5747527b0","fullLoad":false}]
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"taskInstanceId": "e193cba7-2b2c-48c7-8388-c0ff4796975c","failBeans": []},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Получение информации об этом экземпляре обновления

Профиль интерфейса

роль интерфейсаПолучение информации об этом обновлении на основе идентификатора задачи обновления.
URL-адрес интерфейса/v5/api/conf/update/instance/{taskInstanceId}
Тип запросаПОЛУЧИТЬ
предостережениеtaskInstanceId - идентификаторзадачи обновления.

Пример ответа

Пример запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/conf/update/instance/e193cba7-2b2c-48c7-8388-c0ff4796975c?fine_auth_token=xxxПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"taskInstanceId": "e193cba7-2b2c-48c7-8388-c0ff4796975c","taskName": "BI-Update_Api_Batch_Update"," startTime": 1669027681571."endTime": 1669027683766." состояние": 1."Ожидание статуса": 0,"triggerMode": 1,"triggerType": 3,"costTime": 2195."resultType": 1,"roleName": "API","baseTableExpect": 6,"baseTableFinish": 6,"analysisTableExpect": 0,"analysisTableFinish": 0,"relationExpect": 0,"relationFinish": 0,"auth": true,"Процесс": 0.0,"отменить": false,"inLine": false},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Описание параметров ответа

параметрическийзаявление о стоимости
taskInstanceIdОбновленные идентификаторы задач
taskNameОбновление названий миссий
startTimeВремя начала обновления
endTimeВремя окончания обновления
государствоОбновление статуса1: Закрыто2: В работе
triggerTypeметод запуска1: Руководство2: Сроки3: Внутренний
resultTypeРезультаты бега 1:Все успехи 2: Частичный успех