调用ListFavoriteReports获取首页看板收藏列表_智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

获取指定用户在首页看板中展示的收藏作品列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
UserId	string	是	要查询用户在 Quick BI 中的 UserID。	b5d8fd9348cc4327****afb604
Keyword	string	否	作品名称的关键字。	财务报表
TreeType	string	否	查询作品的类型（填空查询所有类型）。取值范围： DATAPRODUCT：数据门户 PAGE：仪表板 REPORT：电子表格	PAGE
PageSize	integer	否	查询作品列表的行数：默认值：10 最大值：9999	10

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	返回查询结果。
TotalNum	integer	总行数。	1
TotalPages	integer	总页数。	1
PageNum	integer	页码。	1
PageSize	integer	请求接口时设置的每页行数。	10
Data	array<object>	查询到的作品列表。
Data	object
TreeId	string	作品 ID。	977c7698-**--**-44b7304d20fc
Type	string	作品类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表板 REPORT：电子表格	PAGE
Name	string	作品名称。	测试报表
OwnerNum	string	作品所有者的 UserID。	1365*****238860
OwnerName	string	作品所有者的阿里云账号名。	luyaotest的昵称非管理员
GmtCreate	string	作品创建时间戳。	1640088615000
GmtModified	string	作品修改的时间戳。	1640595729000
PublishStatus	integer	作品的发布状态。取值范围： 0：未发布 1：已发布 2：已修改保存未发布 3：已下线	1
Favorite	boolean	查询用户是否收藏了该作品。	true
HasViewAuth	boolean	查询用户是拥有作品的查看权限。	true
HasEditAuth	boolean	查询用户是拥有作品的编辑权限。	true
WorkspaceId	string	作品所属的工作空间 ID。	523793cb-**--**-aa71c65ffa39
WorkspaceName	string	作品所属的工作空间名称。	测试工作空间
FavoriteDate	string	作品收藏时间戳	1640088615000
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "TotalNum": 1,
    "TotalPages": 1,
    "PageNum": 1,
    "PageSize": 10,
    "Data": [
      {
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "Name": "测试报表",
        "OwnerNum": "1365*****238860",
        "OwnerName": "luyaotest的昵称非管理员",
        "GmtCreate": "1640088615000",
        "GmtModified": "1640595729000",
        "PublishStatus": 1,
        "Favorite": true,
        "HasViewAuth": true,
        "HasEditAuth": true,
        "WorkspaceId": "523793cb-****-****-****-aa71c65ffa39",
        "WorkspaceName": "测试工作空间",
        "FavoriteDate": "1640088615000"
      }
    ]
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	Internal.System.Error	An internal system error occurred.	系统内部异常。
400	Invalid.User.Organization	The user is not in your organization.	该用户不在您的组织中。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-21	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情