SaveFavorites - 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 user's favorite work

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:SaveFavorites	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The user ID of the person who favorites the work. This user ID is the UserID of Quick BI, not the UID of Alibaba Cloud.	121344444790****
WorksId	string	Yes	The ID of the work being favorited.	d23e84a1-82a0-4292-bfdb-521306c3****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	boolean	Returns the result of the interface execution. Possible values: true: Execution successful false: Execution failed	true
Success	boolean	Indicates whether the request was successful. Possible values: true: Request successful false: Request failed	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": true,
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
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.Status.Error	This group workspace has been disabled or deleted.	This group workspace has been disabled or deleted.

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