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

Queries the list of works that a user has permission to view, including reports in workspaces and those shared through authorization.

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 is successful. false: The request fails.	true
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	array<object>	The list of works that the user has permission to view.
	array<object>
CreateTime	string	The millisecond timestamp of the creation time.	1611023338000
Description	string	The description of the work.	Remarks
Directory	object	The directory structure where the work is located.
Id	string	The ID of the directory.	e4276ea5-b232-4fb1-8f0f-efcee4a2****
Name	string	The name of the directory.	Test directory
PathId	string	The hierarchical structure of directory IDs, separated by forward slashes (/).	e4276ea5-b232-4fb1-8f0f-efcee4a2****
PathName	string	The hierarchical structure of directory names, separated by forward slashes (/).	Test directory
ModifyName	string	The Alibaba Cloud account name of the user who last modified the work.	Li Si
ModifyTime	string	The millisecond timestamp of the last modification time.	1611023338000
OwnerId	string	The Quick BI user ID of the work owner.	46e5374665ba4b679ee22e2a2927****
OwnerName	string	The Alibaba Cloud account name of the work owner.	Zhang San
SecurityLevel	string	The security policy for collaborative authorization of the work. Valid values: 0: private 12: authorized to specified members 1 or 11: authorized to all workspace members Note If you use the legacy permission model, the value 1 is returned. If you use the new permission model, the value 11 is returned.	0
Status	integer	The status of the report. Valid values: 0: unpublished 1: published 2: modified but unpublished 3: offline	1
ThirdPartAuthFlag	integer	The third-party embedding status. Valid values: 0: Embedding is not enabled. 1: Embedding is enabled.	1
WorkName	string	The name of the work.	Company region table
WorkType	string	The type of the work. Valid values: DATAPRODUCT: Data portal PAGE: Dashboard (legacy) FULLPAGE: Full-screen dashboard REPORT: Workbook DASHBOARD: Dashboard (new) DATAFORM: Data entry form dashboardOfflineQuery: Ad hoc query ANALYSIS: Ad hoc analysis SCREEN: Data screen	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.	Test workspace

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": [
    {
      "CreateTime": "1611023338000",
      "Description": "Description\n",
      "Directory": {
        "Id": "e4276ea5-b232-4fb1-8f0f-efcee4a2****",
        "Name": "Test directory\n",
        "PathId": "e4276ea5-b232-4fb1-8f0f-efcee4a2****",
        "PathName": "Test directory\n"
      },
      "ModifyName": "Li Si\n",
      "ModifyTime": "1611023338000",
      "OwnerId": "46e5374665ba4b679ee22e2a2927****",
      "OwnerName": "Tom\n",
      "SecurityLevel": "0",
      "Status": 1,
      "ThirdPartAuthFlag": 1,
      "WorkName": "Company Region Table\n",
      "WorkType": "PAGE",
      "WorksId": "03366b16-69ce-43c8-b782-56c2f6ec****",
      "WorkspaceId": "89713491-cb4f-4579-b889-e82c35f1****",
      "WorkspaceName": "Test Workspace\n"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.