报告相关 - 报告书签相关接口 - 《有数BI用户手册》

报告书签相关接口

更新时间: 2023-12-04 19:35:16

1. 添加书签
2. 删除书签
3. 更新书签
4. 添加书签文件夹
5. 删除书签文件夹
6. 更新书签文件夹
7. 获取书签列表

1. 添加书签

（1）接口说明：根据配置信息新增报告书签。

（2）权限说明：使用 token 访问，只有当前报告的预览权限才能调用该接口。

（3）基本信息：

API：/api/dash/bookmark/add
Method：POST

（4）请求参数

字段名称	参数类型	参数说明
token	String	鉴权 token，该用户必须有该报告的预览权限
category	Int	书签类型，0 表示公共书签，1表示私人书签
dashboardId	Int	报告的页面ID
name	String	书签名称
folderId	Int	要添加到哪个文件下对应的文件夹ID
setting	Int	书签的配置信息，主要用于 iframe 集成时从子页面获取对应的配置信息

（5）返回结果示例

{
    "code": 200,
    "result": "ok", //新增书签的ID
    "logPath": "http://127.0.0.1:8009/operation/log/qC1oooi5LthtzKoaxVs5o5"
}

2. 删除书签

（1）接口说明：根据书签ID删除对应的报告书签

（2）权限说明：使用 token 访问，只有当前报告的预览权限才能调用该接口。

（3）基本信息

API：/api/dash/bookmark/delete
Method：POST

（4）请求参数

字段名称	参数类型	参数说明
token	String	鉴权 token，该用户必须有该报告的预览权限
id	Int	书签ID

（5）返回结果示例

{
    "code": 200,
    "result": "ok",
    "logPath": "http://127.0.0.1:8009/operation/log/qC1oooi5LthtzKoaxVs5o5"
}

3. 更新书签

（1）接口说明：根据书签ID更新对应的报告书签的配置信息

（2）权限说明：使用 token 访问，只有当前报告的预览权限才能调用该接口。

（3）基本信息

API：/api/dash/bookmark/update
Method：POST

（4）请求参数

字段名称	参数类型	参数说明
token	String	鉴权 token，该用户必须有该报告的预览权限
id	Int	书签ID
category	Int	书签类型，0 表示公共书签，1表示私人书签
name	String	书签名称
folderId	Int	要添加到哪个文件下对应的文件夹ID
setting	Int	书签的配置信息，主要用于 iframe 集成时从子页面获取对应的配置信息

（5）返回结果示例

{ "code": 200, "result": "ok", "logPath": "http://127.0.0.1:8009/operation/log/qC1oooi5LthtzKoaxVs5o5" }

4. 添加书签文件夹

（1）接口说明：添加书签文件夹

（2）权限说明：使用 token 访问，只有当前报告的预览权限才能调用该接口。

（3）基本信息

API：/api/dash/bookmark/folder/add
Method：POST

（4）请求参数

字段名称	参数类型	参数说明
token	String	鉴权 token，该用户必须有该报告的预览权限
category	Int	书签文件夹类型，0 表示公共书签，1表示私人书签
name	String	书签文件夹名称
dashboardId	Int	页面ID

（5）返回结果示例

{
    "code": 200,
    "result": 12, //书签文件夹的ID
    "logPath": "http://127.0.0.1:8009/operation/log/qC1oooi5LthtzKoaxVs5o5"
}

5. 删除书签文件夹

（1）接口说明：根据书签文件夹ID删除对应的文件夹及书签。

（2）权限说明：使用 token 访问，只有当前报告的预览权限才能调用该接口。

（3）基本信息

API：/api/dash/bookmark/folder/delete
Method：POST

（4）请求参数

字段名称	参数类型	参数说明
token	String	鉴权 token，该用户必须有该报告的预览权限
id	Int	要删除的书签文件夹ID

（5）返回结果示例

{
    "code": 200,
    "result": "ok",
    "logPath": "http://127.0.0.1:8009/operation/log/qC1oooi5LthtzKoaxVs5o5"
}

6. 更新书签文件夹

（1）接口说明：根据书签文件夹ID更新书签文件夹

（2）权限说明：使用 token 访问，只有当前报告的预览权限才能调用该接口。

（3）基本信息

API：/api/dash/bookmark/folder/update
Method：POST

（4）请求参数

字段名称	参数类型	参数说明
token	String	鉴权 token，该用户必须有该报告的预览权限
id	Int	书签文件夹ID
name	String	更新名称

（5）返回结果示例

{
    "code": 200,
    "result": "ok",
    "logPath": "http://127.0.0.1:8009/operation/log/qC1oooi5LthtzKoaxVs5o5"
}

7. 获取书签列表

（1）接口说明：获取某个报告的书签列表

（2）权限说明：使用 token 访问，只有当前报告的预览权限才能调用该接口。

（3）基本信息

API：/api/dash/bookmark/getList
Method：GET

（4）请求参数

字段名称	参数类型	参数说明
token	String	鉴权 token，该用户必须有该报告的预览权限
reportId	Int	报告ID

（5）返回结果示例

{
    "code": 200,
    "result": {
        "privateFolders": [ //私人文件夹列表
            {
                "id": 22070,
                "name": "私人文件夹",
                "category": 1,
                "items": [ //私人文件夹列表下的书签列表
                    {
                        "id": 737,
                        "name": "私人1",
                        "category": 1,
                        "idx": 0,
                        "setting": {},
                        "dashboardId": 71841,
                        "folderId": 22070,
                        "userId": 3672,
                        "creatorId": 3672,
                        "createTime": "2023-11-06T12:43:57.000Z",
                        "modifierId": 3672,
                        "modifyTime": "2023-11-06T12:43:57.000Z",
                        "reportId": 42661,
                        "setAsDefault": 0
                    }
                ],
                "resourceId": 42661
            }
        ],
        "publicFolders": [ //公共文件夹列表
            {
                "id": 22071,
                "name": "公共文件夹",
                "category": 0,
                "items": [ //公共文件夹下的书签列表
                    {
                        "id": 738,
                        "name": "公共1",
                        "category": 0,
                        "idx": 0,
                        "setting": {}, 
                        "dashboardId": 71841,
                        "folderId": 22071,
                        "userId": 3672,
                        "creatorId": 3672,
                        "createTime": "2023-11-06T12:44:06.000Z",
                        "modifierId": 3672,
                        "modifyTime": "2023-11-06T12:44:06.000Z",
                        "reportId": 42661,
                        "setAsDefault": 0
                    }
                ],
                "resourceId": 42661
            }
        ],
        "privateBookmarks": [ //私人全局的书签列表
            {
                "id": 735,
                "name": "私人1",
                "category": 1,
                "idx": 0,
                "dashboardId": 71841,
                "folderId": -1,
                "userId": 3672,
                "setting": {},
                "creatorId": 3672,
                "createTime": "2023-11-06T12:43:00.000Z",
                "modifierId": 3672,
                "modifyTime": "2023-11-06T12:43:00.000Z",
                "reportId": 42661,
                "setAsDefault": 0
            }
        ],
        "publicBookmarks": [ //私人公共的书签列表
            {
                "id": 736,
                "name": "公共1",
                "category": 0,
                "idx": 0,
                "dashboardId": 71841,
                "folderId": 0,
                "userId": 3672,
                "creatorId": 3672,
                "setting": {},
                "createTime": "2023-11-06T12:43:18.000Z",
                "modifierId": 3672,
                "modifyTime": "2023-11-06T12:43:18.000Z",
                "reportId": 42661,
                "setAsDefault": 0
            }
        ],
        "defaultBookmarkId": null
    },
    "apiCost": 13,
    "logPath": "https://netease.backend.youdata.com/operation/log/ewp4U8cZwA9V2qyNdwkh4o"
}