ListCollections - 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.

Retrieve the list of works that a user has favorited.

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:ListCollections	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	User ID. This refers to the UserID in Quick BI, not the Alibaba Cloud UID.	fe67f61a35a94b7da1a34ba174a7****

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	The primary key ID of the favorite record.	true
RequestId	string	Request ID.	162A632E-0A88-51CF-98F8-94FDEE82DB7D
Result	array<object>	Details of the list of reports favored by the user.
Data	object
FavoriteId	integer	The primary key ID of the favorite record.	12373
OwnerId	string	The user ID of the work owner. This refers to the UserID in Quick BI, not the Alibaba Cloud UID.	fe67f61a35a94b7da1a34ba174a7****
WorksId	string	The ID of the work.	95296e95-ca89-4c7d-8af9-dedf0ad0****
WorksName	string	The name of the work.	test
WorksType	string	The type of the work. Possible values: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet dataForm: Data Entry Form dashboardOfflineQuery: Self-service Data Extraction	dashboardOfflineQuery
WorkspaceId	string	Workspace ID.	9337d121-a78f-4c1b-a8bc-f81de117****
WorkspaceName	string	Workspace Name.	test

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "162A632E-0A88-51CF-98F8-94FDEE82DB7D",
  "Result": [
    {
      "FavoriteId": 12373,
      "OwnerId": "fe67f61a35a94b7da1a34ba174a7****",
      "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "WorksName": "test",
      "WorksType": "dashboardOfflineQuery",
      "WorkspaceId": "9337d121-a78f-4c1b-a8bc-f81de117****",
      "WorkspaceName": "test"
    }
  ]
}

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.

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