Use ListSharedReports to query authorized works for a user - Quick BI - Alibaba Cloud - Quick BI

Obtains the list of authorized works displayed on the homepage dashboard for a specified user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:ListSharedReports

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The user ID of the user to query in Quick BI.	b5d8fd9348cc4327****afb604
Keyword	string	No	The keyword to filter works by name.	测试报表
TreeType	string	No	The type of work to query. Leave empty to query all types. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard REPORT: workbook	PAGE
PageSize	integer	No	The number of entries to return per page. Default value: 10. Maximum value: 9999	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The query results.
Data	array<object>	The list of queried works.
	object
Favorite	boolean	Indicates whether the user has favorited 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	Indicates whether the queried user has edit permissions for the work.	true
HasViewAuth	boolean	Indicates whether the queried user has view permissions for the work.	true
Name	string	The name of the work.	测试报表
OwnerName	string	The Alibaba Cloud account name of the work owner.	test账号
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.	测试工作空间
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	10
TotalNum	integer	The total number of entries.	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

Success response

JSON format

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Favorite": true,
        "GmtCreate": "1640088615000",
        "GmtModified": "1644373980000",
        "HasEditAuth": true,
        "HasViewAuth": true,
        "Name": "测试报表",
        "OwnerName": "test账号",
        "OwnerNum": "1365*****238860",
        "PublishStatus": 1,
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "WorkspaceId": "gfidm145-****-****-9426-8f93be23****",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.