Use QueryReadableResourcesListByUserId to query readable resources for a user - Quick BI - Alibaba Cloud - Quick BI

Queries the works that a user has permission to view, including reports shared within a workspace.

Note

This API has been deprecated. We recommend migrating to quickbi-public(2022-01-01) - QueryReadableResourcesListByUserIdV2 for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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:QueryReadableResourcesListByUserId

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The Quick BI user ID.	de4bc5f9429141cc8091cdd1c15b****

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	array<object>	The list of works that the user has permission to view.
	array<object>
CreateTime	string	The creation timestamp, in milliseconds.	1611023338000
Description	string	Remarks on the work.	备注
Directory	object	The directory that contains the work.
Id	string	The ID of the directory.	e4276ea5-b232-4fb1-8f0f-efcee4a2****
Name	string	The name of the directory.	测试目录
PathId	string	The hierarchical path of directory IDs, separated by forward slashes (/).	e4276ea5-b232-4fb1-8f0f-efcee4a2****
PathName	string	The hierarchical path of directory names, separated by forward slashes (/).	测试目录
ModifyName	string	The Alibaba Cloud account name of the modifier.	李四
ModifyTime	string	The last modification timestamp, in milliseconds.	1611023338000
OwnerId	string	The Quick BI UserID of the work owner.	46e5374665ba4b679ee22e2a2927****
OwnerName	string	The Alibaba Cloud account name of the owner.	张三
SecurityLevel	string	The collaborative authorization policy for the work. Valid values: 0: private 12: Authorize specified members 1 or 11: Authorize all workspace members Note If you use legacy permissions, the return value is 1. If you use the new permissions, the return value is 11.	0
Status	integer	The status of the report. Valid values: 0: unpublished 1: published 2: modified but not published 3: unpublished	1
ThirdPartAuthFlag	integer	Third-party embedding status. Valid values: 0: The embed service is not enabled. 1: Embed is enabled.	1
WorkName	string	The name of the work.	公司地区表
WorkType	string	The type of the work. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard FULLPAGE: full-screen dashboards REPORT: workbook	PAGE
WorksId	string	The ID of the work.	03366b16-69ce-43c8-b782-56c2f6ec****
WorkspaceId	string	The ID of the workspace to which the work belongs.	89713491-cb4f-4579-b889-e82c35f1****
WorkspaceName	string	The name of the workspace to which the work belongs.	测试工作空间

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": [
    {
      "CreateTime": "1611023338000",
      "Description": "备注",
      "Directory": {
        "Id": "e4276ea5-b232-4fb1-8f0f-efcee4a2****",
        "Name": "测试目录",
        "PathId": "e4276ea5-b232-4fb1-8f0f-efcee4a2****",
        "PathName": "测试目录"
      },
      "ModifyName": "李四",
      "ModifyTime": "1611023338000",
      "OwnerId": "46e5374665ba4b679ee22e2a2927****",
      "OwnerName": "张三",
      "SecurityLevel": "0",
      "Status": 1,
      "ThirdPartAuthFlag": 1,
      "WorkName": "公司地区表",
      "WorkType": "PAGE",
      "WorksId": "03366b16-69ce-43c8-b782-56c2f6ec****",
      "WorkspaceId": "89713491-cb4f-4579-b889-e82c35f1****",
      "WorkspaceName": "测试工作空间"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.