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

Overview

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

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The UserID of the user in Quick BI to be queried.	b5d8fd9348cc4327****afb604
Keyword	string	No	Keyword of the work name.	test
TreeType	string	No	Type of the work to be queried (leave blank to query all types). Value range: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet	PAGE
PageSize	integer	No	Number of rows in the work list to be queried: Default value: 10 Maximum value: 9999	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Returns the query result.
TotalNum	integer	Total number of rows.	1
TotalPages	integer	Total number of pages.	1
PageNum	integer	Page number.	1
PageSize	integer	Number of rows per page set when requesting the interface.	10
Data	array<object>	List of works queried.
Data	object
TreeId	string	Work ID.	977c7698-**--**-44b7304d20fc
Type	string	Type of the work. Value range: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet	PAGE
Name	string	Name of the work.	test
OwnerNum	string	UserID of the work owner.	1365*****238860
OwnerName	string	Alibaba Cloud account name of the work owner.	test
GmtCreate	string	Timestamp of the work creation.	1640088615000
GmtModified	string	Timestamp of the work modification.	1640595729000
PublishStatus	integer	Publication status of the work. Value range: 0: Not published 1: Published 2: Saved with modifications, not published 3: Offline	1
Favorite	boolean	Indicates whether the user has favorited the work.	true
HasViewAuth	boolean	Check if the user has the permission to view the work.	true
HasEditAuth	boolean	Indicates whether the user has edit permission for the work.	true
WorkspaceId	string	The ID of the workspace to which the work belongs.	523793cb-**--**-aa71c65ffa39
WorkspaceName	string	The name of the workspace to which the work belongs.	test
FavoriteDate	string	The timestamp when the work was favorited.	1640088615000
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "TotalNum": 1,
    "TotalPages": 1,
    "PageNum": 1,
    "PageSize": 10,
    "Data": [
      {
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "Name": "test",
        "OwnerNum": "1365*****238860",
        "OwnerName": "test",
        "GmtCreate": 1640088615000,
        "GmtModified": 1640595729000,
        "PublishStatus": 1,
        "Favorite": true,
        "HasViewAuth": true,
        "HasEditAuth": true,
        "WorkspaceId": "523793cb-****-****-****-aa71c65ffa39",
        "WorkspaceName": "test",
        "FavoriteDate": 1640088615000
      }
    ]
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Invalid.User.Organization	The user is not in your organization.	The user is not in your organization.

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

Change history

Change time	Summary of changes	Operation
2024-05-21	The Error code has changed. The response structure of the API has changed	View Change Details