AddShareReport接口用于添加作品的一个分享配置。

请求参数

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

要执行的操作。取值:AddShareReport。

AuthPoint Integer 3

授权类型。取值范围:

  • 1:仅查看
  • 3:查看并导出
ExpireDate Long 1608202110838

分享的有效期限,格式为毫秒级时间戳 。

ShareToId String de4bc5f9429141cc8091cdd1c15b****

被分享者的ID,可能是Quick BI的用户ID,也可能是用户组ID。

  • ShareToType=0(用户)时,ShareTo为用户ID。
  • ShareToType=1(用户组)时,ShareTo为用户组ID。
  • ShareToType=2(组织)时,ShareTo为组织ID。
ShareToType Integer 0

分享类型。取值范围:

  • 0:用户
  • 1:用户组
  • 2:组织
WorksId String 6b407e50-e774-406b-9956-da2425c2****

分享作品的ID。这里的作品包括数据门户,仪表板,电子表格,自助取数。

返回数据

名称 类型 示例值 描述
RequestId String 05739b8e-3de0-4204-9669-7f04f02522b9

请求ID。

Result Boolean true

返回接口执行结果。取值范围:

  • true:执行成功
  • false:执行失败
Success Boolean true

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

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

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=AddShareReport
&AuthPoint=3
&ExpireDate=1608202110838
&ShareToId=de4bc5f9429141cc8091cdd1c15b****
&ShareToType=0
&WorksId=6b407e50-e774-406b-9956-da2425c2****
&<公共请求参数>

正常返回示例

XML格式

<RequestId>05739b8e-3de0-4204-9669-7f04f02522b9</RequestId>
<Success>true</Success>
<Result>true</Result>

JSON格式

{"RequestId":"05739b8e-3de0-4204-9669-7f04f02522b9","Success":"true","Result":"true"}

错误码

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 Report.NotExist.Error This work does not exist. It may have been deleted. Work ID is %s. 作品不存在,可能已经被删除。作品ID:%s。
500 Workspace.Not.Exist The group workspace does not exist. 群空间不存在。
500 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Workspace.Share.Forbidden Content in the current group workspace cannot be shared. 当前群空间设置了禁止分享。
500 Invalid.User.Organization The user is not in your organization. 该用户不在您的组织中。
500 UserInfo.Error The personal information is invalid. 个人信息不合法。
500 Workspace.OutsideShare.Forbidden Content in the current group workspace cannot be shared with another organization. 当前群空间设置了禁止组织外分享。
500 Usergroup.Not.Exist The user group does not exist. 用户组不存在。
500 UserGroup.NotIn.Organization The user group is not in the current organization. 用户组不在当前组织内。
500 Invalid.Param.Error The parameter is invalid. 无效参数。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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