ListSharedReports - Quick BI - Alibaba Cloud Documentation Center

You can this operation to obtain the list of authorized works displayed on the homepage of a specified user.

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

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The UserID of the user to be queried in the Quick BI.	b5d8fd9348cc4327****afb604
Keyword	string	No	Keyword of the name of the work.	Test report
TreeType	string	No	Query the type of the work (fill in the blank to query all types). Valid values: DATAPRODUCT: BI portal PAGE: Dashboard REPORT: workbook	PAGE
PageSize	integer	No	Query the number of rows in the work list: Default value: 10. Maximum value: 9999	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The query results are returned.
Data	array<object>	The list of queried works.
Data	object
Favorite	boolean	Queries whether the user has collected the work.	true
GmtCreate	string	The timestamp when the work was created.	1640088615000
GmtModified	string	The timestamp when the work was modified.	1644373980000
HasEditAuth	boolean	The query user has the editing rights of the work.	true
HasViewAuth	boolean	The query user has the permission to view the work.	true
Name	string	The name of the work.	Test report
OwnerName	string	The Alibaba Cloud account name of the work owner.	test account
OwnerNum	string	The UserID of the work owner.	1365*****238860
PublishStatus	integer	The publication status of the work. Valid values: 0: unpublished 1: published 2: modified and saved but not published. 3: unpublished	1
TreeId	string	The ID of the work.	977c7698-**--**-44b7304d20fc
Type	string	The type of the work. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard REPORT: workbook	PAGE
WorkspaceId	string	The ID of the workspace to which the work belongs.	gfidm145-**--9426-8f93be23**
WorkspaceName	string	The name of the workspace to which the work belongs.	Test Workspace
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of rows per page set when the interface is requested.	10
TotalNum	integer	The total number of rows in the table.	1
TotalPages	integer	The total number of pages returned.	1
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": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Favorite": true,
        "GmtCreate": "1640088615000",
        "GmtModified": "1644373980000",
        "HasEditAuth": true,
        "HasViewAuth": true,
        "Name": "Test report\n",
        "OwnerName": "test account\n",
        "OwnerNum": "1365*****238860",
        "PublishStatus": 1,
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "WorkspaceId": "gfidm145-****-****-9426-8f93be23****",
        "WorkspaceName": "Test Workspace\n"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

Error codes

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