Skip to content

Интерфейс редактора приборной панели - Справка FineReport | Разработка отчетов | Отчеты | Учебные пособия

Интерфейс редактора приборной панели

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

выпускает

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

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

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

Новая дашборд

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

роль интерфейсаНовая дашборд
URL-адрес интерфейса/v5/api/platform/dashboard/reports
Тип запросаПОЛУЧИТЬ

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

имя параметразначение параметраТребуется или нетОписание
данные{"subjectId": "subjectId"."reportName": "Название приборной панели"}Примечание: Значения параметров представлены в формате JSON и должны быть закодированы при использовании функции encodeURIComponent()быть1) subjectId: идентификатор предмета, в котором находится дашборд выбора темы идентификатор после темы в URL является идентификатором темы.2) reportName: название приборной панели

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

Пример запросаПредварительное кодирование значений параметров:{ "subjectId": "e5c58a91c26143299551ba73d856242f", "reportName": "Пример приборной панели"}.Значения параметров посткодирования:%7B%22subjectId%22%3A%22e5c58a91c26143299551ba73d856242f%22%2C%22reportName%22%3A%22%E7%A4%BA%E4%BE%8B%E4%BB%AA%E8%A1%A8%E6%9D%BF% 22%7D**Ссылка:**http://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/reports?data=%7B%22subjectId%22%3A% 22e5c58a91c26143299551ba73d856242f%22%2C%22reportName%22%3A%22%E7%A4%BA%E4%BE%8B%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%7D&fine_auth_ токен=xxxПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"name": "Sample Dashboard","initTime": 0,"lastUpdateTime": 0,"id": "eac08a88be5d42d2878870eed76dc2ab","общий": false," publishStatus": 0,"Редактируемый": true," publicLink": {"общий": false,"passProtected": false,"крайний срок": 0},"coopAnalysis": false,"creatorAuth": false},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

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

параметрыОписание значений параметров
имяНазвание приборной панели
initTimeВремя создания
lastUpdateTimeПоследнее изменение
idИдентификатор приборной панели
общийСтоит ли делитьсяправда: даложь: нет
публичный статусСтатус размещения0: Не опубликовано1: Опубликовано
редактируемыйРедактируемый или нетправда: даложь: Нет
publicLinkпубличная ссылка
coopAnalysisСотрудничать ли с текущим пользователемправда: даложь: Нет
creatorAuthИмеете ли вы равные привилегии с создателемправда: даложь: нет

Удалить приборную панель

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

роль интерфейсаУдалить приборную панель
URL-адрес интерфейса/v5/api/platform/dashboard/report
Тип запросаПОЛУЧИТЬ

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

имя параметразначение параметраТребуется или нет
reportIdИдентификаторы приборных панелей, которые необходимо удалитьбыть

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

Пример запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/report?reportId=eac08a88be5d42d2878870eed76dc2ab&fine_auth _token=xxxПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": []."errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Переименовать приборную панель

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

роль интерфейсаПереименовать приборную панель
URL-адрес интерфейса/v5/api/platform/dashboard/rename
Тип запросаПОЛУЧИТЬ

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

имя параметразначение параметраТребуется или нетОписание
информация{"reportId": "dashboardId"."nameUpdateBean".{"name": "Новое имя для приборной панели","mouduleType": "1/2"}}Примечание: Значения параметров представлены в формате JSON и должны быть закодированы при использовании функции encodeURIComponent()быть1) reportID: идентификатор приборной панели2) имя: новое имя приборной панели3) mouduleType: категории модулей (1: Public Data, 2: мои анализы)

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

Пример запросаПредварительное кодирование значений параметров:{ "reportId": "c2594718581f493f951f055b0f3122f6", "nameUpdateBean":{ "name": "Newbie Getting Started Example ", "mouduleType": "2"}}Значения параметров посткодирования:%7B%22reportId%22%3A%22c2594718581f493f951f055b0f3122f6%22%2C%22nameUpdateBean%22%3A%7B%22name%22%3A%22%E6%96%B0%E6%89%8B%E5%85% A5%E9%97%A8%E7%A4%BA%E4%BE%8B%22%2C%22mouduleType%22%3A%222%22%7D%7D**Ссылка:**http://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/rename?info=%7B%22reportId%22%3A% 22c2594718581f493f951f055b0f3122f6%22%2C%22nameUpdateBean%22%3A%7B%22name%22%3A%22%E6%96%B0%E6%89%8B%E5%85%A5%E9%97%A8%E7%A4%BA% E4%BE%8B%22%2C%22mouduleType%22%3A%222%22%7D%7D&fine_auth_token=xxxПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": []."errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Сохранить приборную панель как

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

роль интерфейсадашборд Сохранить как
URL-адрес интерфейса/v5/api/platform/dashboard/saveas
Тип запросаПОСТ

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

параметрыТребуется или нетОписание
{" subjectId": "subjectId"."originReportId": "dashboardId"."name": "Новое название приборной панели".}быть1) subjectId: идентификатор субъекта, в который необходимо скопировать приборную панель2) originReportId: идентификатор приборной панели, которую необходимо реплицировать3) имя: имя новой панели инструментов

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

Ссылка для запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/saveas?fine_auth_token=xxxПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Тело запроса{" subjectId":"e5c58a91c26143299551ba73d856242f","originReportId":"c2594718581f493f951f055b0f3122f6",."name": "Новая дашборд"}
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"name": "Новая дашборд"."initTime": 0,"lastUpdateTime": 0,"id": "d50955bcbe8e4823b9d5c206e71c8672","общий": false," publishStatus": 0,"Редактируемый": true," publicLink": {"общий": false,"passProtected": false,"крайний срок": 0},"coopAnalysis": false,"creatorAuth": false},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Создание общедоступных ссылок

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

роль интерфейсаСоздание публичных ссылок на приборные панели
URL-адрес интерфейса/v5/api/platform/dashboard/{reportId}/create
Тип запросаПОЛУЧИТЬ
предостережениеReportID - это идентификатор приборной панели

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

Пример запросаhttp://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/6aae904df9284bef823921fac05fb247/create?fine_auth_token=xxxПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"общий": правда,"uri": "eyJhbGciOiJIUzI1NiJ9. eyJyZXBvcnRJZCI6IjZhYWU5MDRkZjkyODRiZWY4MjM5MjFmYWMwNWZiMjQ3IiwidXNlcklkIjoiYjVmMGMyZWUtNjQwZi00MDM5LWE0ZDQtOTE4YjU1MzU0ODk4IiwianRpIjoiand0In0 .yYFVpSwlmFieGoK01ghIOTHw5HudraJ5dzvYdtvzfCw","reportId": "6aae904df9284bef823921fac05fb247","linkId": "tMnh"."userId": "b5f0c2ee-640f-4039-a4d4-918b55354898","пароль": null,"passProtected": false},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот