QueryReadableResourcesListByUserId - Quick BI - Alibaba Cloud Documentation Center

Queries the list of works that a user has the permission to view, including the statements that are authorized to share in a space.

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

Request parameters

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

Response parameters

Parameter	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.
Data	object
CreateTime	string	The timestamp of the creation time in milliseconds.	1611023338000
Description	string	Remarks on the work.	Description
Directory	object	The directory structure in which 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 the directory ID, which is separated with '/'.	e4276ea5-b232-4fb1-8f0f-efcee4a2****
PathName	string	The hierarchical structure of the directory name, which is separated with '/'.	Test directory
ModifyName	string	The name of the Alibaba Cloud account to which the modifier belongs.	Li Si
ModifyTime	string	The timestamp of the modification time in milliseconds.	1611023338000
OwnerId	string	The Quick BI UserID of the work owner.	46e5374665ba4b679ee22e2a2927****
OwnerName	string	The Alibaba Cloud account name of the owner.	Tom
SecurityLevel	string	Security policies for collaborative authorization of works. 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.	Company Region Table
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.	Test Workspace

Examples

Sample success responses

JSONformat

{
  "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

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