文档

ListCollections - 获取用户收藏作品列表

更新时间:

获取用户收藏的作品列表。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
UserIdstring

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

fe67f61a35a94b7da1a34ba174a7****

返回参数

名称类型描述示例值
object
Successboolean

收藏记录的主键 ID。

true
RequestIdstring

请求 ID。

162A632E-0A88-51CF-98F8-94FDEE82DB7D
Resultobject []

用户收藏的报表列表详情。

WorkspaceIdstring

工作空间 ID。

9337d121-a78f-4c1b-a8bc-f81de117****
WorksTypestring

作品类型。取值范围:

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • REPORT:电子表格
  • dataForm:数据填报
  • dashboardOfflineQuery:自助取数
dashboardOfflineQuery
FavoriteIdinteger

收藏记录的主键 ID。

12373
WorksIdstring

作品的 ID。

95296e95-ca89-4c7d-8af9-dedf0ad0****
WorksNamestring

作品的名称。

奇异博士
WorkspaceNamestring

工作空间名称。

测试工作空间
OwnerIdstring

作品所有者的用户 ID。此处的用户 ID 为 Quick BI 的 UserID,而非阿里云的 UID。

fe67f61a35a94b7da1a34ba174a7****

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "162A632E-0A88-51CF-98F8-94FDEE82DB7D",
  "Result": [
    {
      "WorkspaceId": "9337d121-a78f-4c1b-a8bc-f81de117****",
      "WorksType": "dashboardOfflineQuery",
      "FavoriteId": 12373,
      "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "WorksName": "奇异博士",
      "WorkspaceName": "测试工作空间",
      "OwnerId": "fe67f61a35a94b7da1a34ba174a7****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

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

  • 本页导读 (0)
文档反馈