文档

QueryShareList - 查询作品的分享记录

更新时间:

查询作品被分享给哪些对象的列表,只返回仍然在有效期限内的分享配置。

调试

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

授权信息

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

请求参数

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

作品 ID。这里的作品包括数据门户、仪表板、电子表格、自助取数、即席分析、数据填报、数据大屏。

6b407e50-e774-406b-9956-da2425c2****

返回参数

名称类型描述示例值
object
Successboolean

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

  • true:请求成功
  • false:请求失败
true
RequestIdstring

请求 ID。

DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Resultobject []

返回作品被分享给的对象列表。

ShareIdstring

分享配置 ID。

0ab9659e-29cf-47d7-a364-3a91553b****
ShareToIdstring

分享目标的 ID,可能是在 Quick BI 的用户 ID,可能是用户组 ID。

  • 当 ShareToType=2(所有组织内的成员)的时候,ShareToId 为组织 ID。
95296e95-ca89-4c7d-8af9-dedf0ad0****
AuthPointinteger

分享权限。取值范围:

  • 1:仅查看
  • 3:查看和导出
3
ExpireDatelong

授权有效时间的毫秒级时间戳。

1640102400000
ShareToTypeinteger

分享类型。取值范围:

  • 0:用户
  • 1:用户组
  • 2:组织
  • 3:空间
0
ReportIdstring

作品 ID。

6b407e50-e774-406b-9956-da2425c2****
ShareToNamestring

分享对象的名称。

小张
ShareTypestring

被分享作品的类型。取值范围:

  • product:数据门户
  • dashboard:仪表板
  • worksheet:电子表格
  • dashboardOfflineQuery:自助取数
  • ANALYSIS:即席分析
  • DATAFORM:数据填报
  • SCREEN:数据大屏
product

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": [
    {
      "ShareId": "0ab9659e-29cf-47d7-a364-3a91553b****",
      "ShareToId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "AuthPoint": 3,
      "ExpireDate": 1640102400000,
      "ShareToType": 0,
      "ReportId": "6b407e50-e774-406b-9956-da2425c2****",
      "ShareToName": "小张",
      "ShareType": "product"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Report.NotExist.ErrorThis work does not exist. It may have been deleted. Work ID is %s.作品不存在,可能已经被删除。作品ID:%s。
400Workspace.Not.ExistThe group workspace does not exist.群空间不存在。
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)
文档反馈