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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListFavoriteReports

要执行的操作。取值：ListFavoriteReports。
UserId String 是 b5d8fd9348cc4327****afb604

要查询用户在Quick BI中的UserId。
Keyword String 否 财务报表

作品名称的关键字。
TreeType String 否 PAGE

查询作品的类型（填空查询所有类型）。取值范围 ：

  • DATAPRODUCT：数据门户
  • PAGE：仪表板
  • REPORT：电子表格
PageSize Integer 否 10

查询作品列表的行数：

默认值：10

最大值：9999

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。
Result Object

返回查询结果。
TotalNum Integer 10

总行数。
TotalPages Integer 1

总页数。
PageNum Integer 1

页码。
PageSize Integer 10

请求接口时设置的每页行数。
Data Array of Data

查询到的作品列表。
TreeId String 977c7698-****-****-****-44b7304d20fc

作品ID。
Type String PAGE

作品类型。取值范围 ：

  • DATAPRODUCT：数据门户
  • PAGE：仪表板
  • REPORT：电子表格
Name String 测试报表

作品名称。
OwnerNum String 1365*****238860

作品所有者的UserID。
OwnerName String test账号

作品所有者的阿里云账号名。
GmtCreate String 1640088615000

作品创建时间戳。
GmtModified String 1640595729000

作品修改的时间戳。
PublishStatus Integer 1

作品的发布状态。取值范围：

  • 0：未发布
  • 1：已发布
  • 2：已修改保存未发布
  • 3：已下线
Favorite Boolean true

查询用户是否收藏了该作品。
HasViewAuth Boolean true

查询用户是拥有作品的查看权限。
HasEditAuth Boolean true

查询用户是拥有作品的编辑权限。
WorkspaceId String 523793cb-****-****-****-aa71c65ffa39

作品所属的工作空间ID。
WorkspaceName String 测试工作空间

作品所属的工作空间名称。
Success Boolean true

是否请求成功。取值范围：

  • true：请求成功
  • false：请求失败

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=ListFavoriteReports
&UserId=b5d8fd9348cc4327****afb604
&Keyword=财务报表
&TreeType=PAGE
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFavoriteReportsResponse>
    <RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
    <Result>
        <TotalNum>10</TotalNum>
        <TotalPages>1</TotalPages>
        <PageNum>1</PageNum>
        <PageSize>10</PageSize>
        <Data>
            <TreeId>977c7698-****-****-****-44b7304d20fc</TreeId>
            <Type>PAGE</Type>
            <Name>测试报表</Name>
            <OwnerNum>1365*****238860</OwnerNum>
            <OwnerName>test账号</OwnerName>
            <GmtCreate>1640088615000</GmtCreate>
            <GmtModified>1640595729000</GmtModified>
            <PublishStatus>1</PublishStatus>
            <Favorite>true</Favorite>
            <HasViewAuth>true</HasViewAuth>
            <HasEditAuth>true</HasEditAuth>
            <WorkspaceId>523793cb-****-****-****-aa71c65ffa39</WorkspaceId>
            <WorkspaceName>测试工作空间</WorkspaceName>
        </Data>
    </Result>
    <Success>true</Success>
</ListFavoriteReportsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
500 Internal.System.Error An internal system error occurred. 系统内部异常。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Invalid.User.Organization The user is not in your organization. 该用户不在您的组织中。

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