文档

AddShareReport - 添加数据作品分享配置

更新时间:

添加数据作品的一个分享配置。

调试

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

授权信息

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

请求参数

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

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

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

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

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

分享类型。取值范围:

  • 0:用户
  • 1:用户组
  • 2:组织
0
ExpireDatelong

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

1608202110838
AuthPointinteger

授权类型。取值范围:

  • 1:仅查看
  • 3:查看并导出
3

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

05739b8e-3de0-4204-9669-7f04f02522b9
Resultboolean

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

  • true:执行成功
  • false:执行失败
true
Successboolean

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

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
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.空间不在组织内。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Workspace.Share.ForbiddenContent in the current group workspace cannot be shared.当前群空间设置了禁止分享。
400Invalid.User.OrganizationThe user is not in your organization.该用户不在您的组织中。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400Workspace.OutsideShare.ForbiddenContent in the current group workspace cannot be shared with another organization.当前群空间设置了禁止组织外分享。
400Usergroup.Not.ExistThe user group does not exist.用户组不存在。
400UserGroup.NotIn.OrganizationThe user group is not in the current organization.用户组不在当前组织内。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Share.ExpireDate.ErrorThe expire date is illegal.设置的过期时间不合法。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
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调用授权用户。

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

变更历史

变更时间变更内容概要操作
2023-10-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400