ListCollections接口用于获取用户收藏的报表列表。

请求参数

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

要执行的操作。取值：ListCollections。
UserId String 是 fe67f61a35a94b7da1a34ba174a7****

用户ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。

返回数据

名称 类型 示例值 描述
RequestId String C67ABB01-F057-48A5-899E-D72682B0B214

请求ID。
Result Array of Data

用户收藏的报表列表详情。
FavoriteId Integer 12373

收藏记录的主键 ID。
OwnerId String fe67f61a35a94b7da1a34ba174a7****

作品所有者的用户ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。
WorksId String 355dd2c5-ffe2-4692-bd12-a2696b43****

作品的ID。
WorksName String 奇异博士

作品的名称。
WorksType String dashboardOfflineQuery

作品类型。取值范围：

  • DATAPRODUCT：数据门户
  • PAGE：仪表板
  • REPORT：电子表格
  • dataForm：数据填报
  • dashboardOfflineQuery：自助取数
WorkspaceId String 9337d121-a78f-4c1b-a8bc-f81de117****

工作空间ID。
WorkspaceName String 测试工作空间

工作空间名称。
Success Boolean true

收藏记录的主键 ID。

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=ListCollections
&UserId=fe67f61a35a94b7da1a34ba174a7****
&<公共请求参数>

正常返回示例

XML格式 

<RequestId/>
<Success>true</Success>
<Result>
    <FavoriteId>12373</FavoriteId>
    <WorksType>dashboardOfflineQuery</WorksType>
    <OwnerId>fe67f61a35a94b7da1a34ba174a7****</OwnerId>
    <WorksName>奇异博士</WorksName>
    <WorkspaceId>9337d121-a78f-4c1b-a8bc-f81de117****</WorkspaceId>
    <WorkspaceName>测试工作空间</WorkspaceName>
    <WorksId>355dd2c5-ffe2-4692-bd12-a2696b43****</WorksId>
</Result>

JSON格式 

{"RequestId":"","Success":"true","Result":[{"FavoriteId":"12373","WorksType":"dashboardOfflineQuery","OwnerId":"fe67f61a35a94b7da1a34ba174a7****","WorksName":"奇异博士","WorkspaceId":"9337d121-a78f-4c1b-a8bc-f81de117****","WorkspaceName":"测试工作空间","WorksId":"355dd2c5-ffe2-4692-bd12-a2696b43****"}]}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止，您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Invalid.Parameter An error occurred while verifying parameters. 参数验证失败。
500 System.Param.empty This error code has been discarded. 错误码已废弃。
500 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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