AddShareReport - Quick BI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Add a sharing configuration for data works.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:AddShareReport	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WorksId	string	Yes	The ID of the shared work. The works here include BI portal, dashboards, spreadsheets, and self-service access.	6b407e50-e774-406b-9956-da2425c2****
ShareToId	string	Yes	The ID of the person to be shared, which may be the user ID of the Quick BI or the user group ID. If ShareToType is 0 (user), ShareTo is the user ID. When ShareToType is set to 1 (user group), ShareTo is the user group ID. When ShareToType=2 (organization), ShareTo is the ID of the organization.	de4bc5f9429141cc8091cdd1c15b****
ShareToType	integer	Yes	The share type of the template. Valid values: 0: user 1: user group 2: organization	0
ExpireDate	long	Yes	The validity period of the share. The value is a timestamp in milliseconds.	1608202110838
AuthPoint	integer	Yes	The scope of authorization. Valid values: 1: view only 3: View and export	3

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	05739b8e-3de0-4204-9669-7f04f02522b9
Result	boolean	The execution result of the interface is returned. Valid values: true: The request was successful. false: The request fails.	true
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-24	The Error code has changed	View Change Details

HTTP status code	Error code	Error message	Description
400	Instance.Expired	Your instance has expired.	Your instance has expired.
400	Instance.Not.Exist	The specified instance does not exist.	The specified instance does not exist.
400	Access.Forbidden	Access forbidden. Your instance version or access key is not allowed to call the API operation.	-
400	Invalid.Organization	The specified organizational unit does not exist.	The specified organizational unit does not exist.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
400	Report.NotExist.Error	This work does not exist. It may have been deleted. Work ID is %s.	This work does not exist. It may have been deleted. Work ID is %s.
400	Workspace.Not.Exist	The group workspace does not exist.	The group workspace does not exist.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
400	System.Param.Empty	You must specify the %s parameter.	You must specify the %s parameter.
400	Workspace.Share.Forbidden	Content in the current group workspace cannot be shared.	Content in the current group workspace cannot be shared.
400	Invalid.User.Organization	The user is not in your organization.	The user is not in your organization.
400	UserInfo.Error	The personal information is invalid.	The personal information is invalid.
400	Workspace.OutsideShare.Forbidden	Content in the current group workspace cannot be shared with another organization.	Content in the current group workspace cannot be shared with another organization.
400	Usergroup.Not.Exist	The user group does not exist.	The user group does not exist.
400	UserGroup.NotIn.Organization	The user group is not in the current organization.	Usergroup is not belong to current organization.
400	Invalid.Param.Error	The parameter is invalid.	The parameter is invalid.
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Share.ExpireDate.Error	The expire date is illegal.	-