QueryReadableResourcesListByUserIdV2 - Quick BI - Alibaba Cloud Documentation Center

Queries the list of works that a specified user has permission to view.

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

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	User ID.	asdas*********sdsddf
WorkType	string	No	Work type. Possible values: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet dashboardOfflineQuery: Self-service Data Extraction SCREEN: Data Wall DATAFORM: Data Entry ANALYSIS: Ad-hoc Analysis	DATAFORM
WorkspaceId	string	No	Workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****

Response elements

Element	Type	Description	Example
	object	Response schema.
Success	boolean	Indicates whether the request was successful. Possible values: true: Request succeeded false: Request failed	true
RequestId	string	Request ID.	D787E1A3-A93C********05DF8D885
Result	array<object>	Query results.
	array<object>	List of works that the user has permission to view.
Status	integer	Report status. Possible values: 0: Unpublished 1: Published 2: Modified but not published 3: Offline	1
ModifyTime	string	Timestamp of the last modification in milliseconds.	1530078690000
OwnerName	string	Alibaba Cloud account name of the owner.	张三
Description	string	Work remarks.	备注
WorkType	string	Work type. Possible values: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet dashboardOfflineQuery: Self-service Data Extraction SCREEN: Data Wall DATAFORM: Data Entry ANALYSIS: Ad-hoc Analysis	PAGE
ModifyName	string	Alibaba Cloud account name of the modifier.	李四
CreateTime	string	Timestamp of creation in milliseconds.	1611023338000
WorkspaceId	string	ID of the workspace to which the work belongs.	c5f86ad2-ef53-4c51-8720-162ecfdb****
ThirdPartAuthFlag	integer	Third-party embedding status. Possible values: 0: Embedding not enabled 1: Embedding enabled	1
OwnerId	string	User ID of the work owner in Quick BI.	fe67f61a35a94b7da1a34ba174a7****
SecurityLevel	string	Collaboration security policy. Possible values: 0: Private 12: Authorize specific members 1 or 11: Authorize all workspace members Note If you are using the old version of permissions, the return value is 1. - If you are using the new version of permissions, the return value is 11.	0
WorkName	string	Name of the work.	测试报表
WorkspaceName	string	Name of the workspace to which the work belongs.	测试工作空间
WorksId	string	ID of the work.	ccd3428c-**-**-a608-26bae29dffee
Directory	object	Directory structure of the work.
PathId	string	Hierarchical directory IDs, separated by /.	88b680****
Id	string	ID of the directory to which it belongs.	a3eecab7-618d-4f9f-*****
PathName	string	Hierarchical directory names, separated by /.	一级目录/二级目录
Name	string	Name of the directory to which it belongs.	测试目录

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D787E1A3-A93C********05DF8D885",
  "Result": [
    {
      "Status": 1,
      "ModifyTime": "1530078690000",
      "OwnerName": "张三",
      "Description": "备注",
      "WorkType": "PAGE",
      "ModifyName": "李四",
      "CreateTime": "1611023338000\n",
      "WorkspaceId": "c5f86ad2-ef53-4c51-8720-162ecfdb****",
      "ThirdPartAuthFlag": 1,
      "OwnerId": "fe67f61a35a94b7da1a34ba174a7****",
      "SecurityLevel": "0",
      "WorkName": "测试报表",
      "WorkspaceName": "测试工作空间",
      "WorksId": "ccd3428c-****-****-a608-26bae29dffee",
      "Directory": {
        "PathId": "88b680****",
        "Id": "a3eecab7-618d-4f9f-*****",
        "PathName": "一级目录/二级目录",
        "Name": "测试目录"
      }
    }
  ]
}

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.Param.Error	The parameter is invalid.	The parameter is invalid.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
400	Invalid.User.Organization	The user is not in your organization.	The user is not in your organization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.