Документация FineBI

Оформление

Интерфейс папки с общедоступными данными ​

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

выпускает ​

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

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

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

Добавить папку ​

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

роль интерфейсаДобавить папку
URL-адрес интерфейса/v5/api/pack/{groupId}/add
Тип запросаПОЛУЧИТЬ
предостережение1) При использовании этого интерфейса для добавления папки вы не можете указать имя папки, можно добавить только папку по умолчанию.2) groupId - идентификатор родительской папки

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

Пример запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/pack/6fb11e7b1e6e4ff3bcb907a5747527b0/add?fine_auth_token=XXXПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"id": "2cfe4508927f4f46a6611026177a4fe0","name": "Folders","initTime": 1669101345235."Редактируемый": true,"createBy": "1","parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0","coopAnalysis": false,"creatorAuth": false,"Папки": []." subjects": [],"Таблицы": {}},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

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

параметрическийОписание значений параметров
idИдентификатор созданной папки
имяИмя созданной папки
initTimeВремя создания папки
редактируемыйРедактируемый или нетправда: даложь: нет
createByИмя пользователя создателя папки
parentIDИдентификатор родительской папки, в которой находится папка
coopAnalysisСотрудничать ли с текущим пользователем true: да ложь: нет
creatorAuthОбладать ли равными правами с создателем истинно: да ложь: нет

Переименовать папку ​

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

роль интерфейсаПереименовать папку
URL-адрес интерфейса/v5/api/pack/{packId}/rename
Тип запросаПОЛУЧИТЬ
предостережениеpackId - идентификатор папки

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

имя параметразначение параметраТребуется или нет
newNameНовое название для бизнес-пакетовбыть

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

Пример запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/pack/2cfe4508927f4f46a6611026177a4fe0/rename?newName=银行金融业&fine_auth_token= XXXПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": []."errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Удалить папку ​

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

роль интерфейсаУдалить папку
URL-адрес интерфейса/v5/api/pack/delete
Тип запросаПОСТ
предостережениеВ отличие от интерфейса 5.X

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

телоТребуется или нетОписание
{ "packIds": "folderIds"}.бытьpackIds - это идентификаторы папок, которые будут удалены.

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

Ссылка для запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/pack/delete?fine_auth_token=XXXПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Тело запроса{"packIds":"2cfe4508927f4f46a6611026177a4fe0" }
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {" успех": {"TableNames": [],"widgetIds": [],"reportIds": []," subjectIds": [],"packIds": []},"fail": {"TableNames": [],"widgetIds": [],"reportIds": []," subjectIds": [],"packIds": []},"errorDetailBeanMap": {}},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Получение информации о папке ​

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

роль интерфейсаПолучение информации о папке
URL-адрес интерфейса/v5/api/conf/packs/{packId}/structure
Тип запросаПОЛУЧИТЬ
предостережение1) packId - идентификатор папки2) Отличие от интерфейса 5.X

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

Пример запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/conf/packs/6fb11e7b1e6e4ff3bcb907a5747527b0/structure?fine_auth_token=XXXПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"id": "6fb11e7b1e6e4ff3bcb907a5747527b0","Название": "Образование и обучение","initTime": 1660903942357."Редактируемый": true,"createBy": "1","parentId": "2802469f40b14094aa7372ea2488a830"," должность": "общественные данные/индустриальные данные/образование и обучение"."coopAnalysis": false,"creatorAuth": false,"папки": [{"id": " 2cfe4508927f4f46a6611026177a4fe0","название": "Банковское дело и финансы ","initTime". 1669101345235."Редактируемый": true,"createBy": "1 ","parentId": " 6fb11e7b1e6e4ff3bcb907a5747527b0","coopAnalysis". ложный,"creatorAuth". false,"Папки": []." subjects": [],"Таблицы": {}}]," subjects": [],"Таблицы": {}},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

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

параметрическийОписание значений параметров
idИдентификатор папки
имяИмя папки
initTimeВремя создания папки
редактируемыйМожно ли редактировать папку
createByИмя пользователя создателя папки
parentIDИдентификатор родительской папки, в которой находится папка
позицияИнформация о местоположении папки
coopAnalysisСотрудничать ли с текущим пользователемправда: даложь: нет
creatorAuthИмеете ли вы равные привилегии с создателемправда: даложь: нет
папкиИнформация о вложенных папках в папках

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

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

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

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

Пример запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/conf/packs/6fb11e7b1e6e4ff3bcb907a5747527b0?fine_auth_token=XXXПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"id": "6fb11e7b1e6e4ff3bcb907a5747527b0","Название": "Образование и обучение","initTime": 1660903942357."Редактируемый": true,"createBy": "1","parentId": "2802469f40b14094aa7372ea2488a830"," должность": "общественные данные/индустриальные данные/образование и обучение"."coopAnalysis": false,"creatorAuth": false,"папки": [{"id": " 2cfe4508927f4f46a6611026177a4fe0","название": "Банковское дело и финансы ","initTime". 1669101345235."Редактируемый": true,"createBy": "1 ","parentId": " 6fb11e7b1e6e4ff3bcb907a5747527b0","coopAnalysis". ложный,"creatorAuth". false,"Папки": []." subjects": [],"Таблицы": {}}]," subjects": [],"tables": {"availableTables": [{"имя ": "BI Demo_Teacher_Information_Sheet"," transferName": "education_teacher_information_sheet","тип ": 2," createBy": "1"," initTime": 0," комментарий": null," validStatus": "VALID"," parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0"," редактируемый": true," sqlEditable": true," Должность": "Public Data/Отраслевые данные/Образование и обучение"." publishStatus": 0," coopAnalysis": false," creatorAuth": false," connectionName": "BI Demo"," moduleType": 1," extractDataSetting": 0," inherit": false," belongAnalysis": false," configUpdateTime": 1655283315926," engineType": " spider"}]}},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот

Получение информации о корневой папке Public Data ​

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

роль интерфейсаПолучение информации о корневой папке "Public Data
URL-адрес интерфейса/v5/api/conf/groups
Тип запросаПОЛУЧИТЬ

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

Пример запросаhttp://172.17.0.25:37799/webroot/decision/v5/api/conf/groups?fine_auth_token=XXXПримечание: Для использования интерфейса необходимо войти в систему и передать параметр token.
Ответ успешныйобратный вызов({" Успех": верно,"code": "200","message": " success","data": {"id": "__root_group__","name": "__root_group__","initTime": 0,"Редактируемый": true,"coopAnalysis": false,"creatorAuth": false,"папки": [{"id": " de20c13fdcdd436987289588b232c38c","name": "Функциональные данные& quot;, "name": "Функциональные данные","initTime". 1531138781428."Редактируемый": true,"createBy": "1 ","parentId": " __root_group__","coopAnalysis". ложный,"creatorAuth". false,"Папки": []." subjects": [],"Таблицы": {}},{"id": " 17bb42b152e3425fa0e2dd827191131a","name": "Данные сектора& quot;, "name"."initTime". 1660900345241."редактируемый": true,"createBy": "1 ","parentId": " __root_group__","coopAnalysis". ложный,"creatorAuth". false,"Папки": []." subjects": [],"Таблицы": {}},{"id": " 2802469f40b14094aa7372ea2488a830","name": "Industry Data& quot;, "name": "Industry Data", "name"."initTime". 1663224796865."Редактируемый": true,"createBy": "1 ","parentId": " __root_group__","coopAnalysis". ложный,"creatorAuth". false,"Папки": []." subjects": [],"Таблицы": {}}]},"errorCode": null,"detailErrorMsg": null,"errorMsg": null})
Скриншот