QueryReadableResourcesListByUserIdV2 - Quick BI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query list of works user has permission to view (new)

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:QueryReadableResourcesListByUserIdV2	get	All Resources ``	none	none

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 parameters

Parameter	Type	Description	Example
	object	Schema of Response
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>	Returns the query result.
Data	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.	asdas
Description	string	Work remarks.	asdas
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.	asdas
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	The UserID of the work owner in Quick BI.	fe67f61a35a94b7da1a34ba174a7****
SecurityLevel	string	Security policy for collaborative work. Values: - 0: Private - 12: Authorize specific members - 1 or 11: Authorize all space 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	The name of the work.	asdas
WorkspaceName	string	The name of the workspace to which the work belongs.	asdas
WorksId	string	The ID of the work.	ccd3428c-**-**-a608-26bae29dffee
Directory	object	The directory structure where the work is located.
PathId	string	The hierarchical structure of directory IDs, separated by『/』.	88b680****
Id	string	The ID of the directory to which it belongs.	a3eecab7-618d-4f9f-*****
PathName	string	The hierarchical structure of directory names, separated by『/』.	asdas/safas
Name	string	The name of the directory to which it belongs.	asdas

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C********05DF8D885",
  "Result": [
    {
      "Status": 1,
      "ModifyTime": 1530078690000,
      "OwnerName": "asdas",
      "Description": "asdas",
      "WorkType": "PAGE",
      "ModifyName": "asdas",
      "CreateTime": 1611023338000,
      "WorkspaceId": "c5f86ad2-ef53-4c51-8720-162ecfdb****",
      "ThirdPartAuthFlag": 1,
      "OwnerId": "fe67f61a35a94b7da1a34ba174a7****",
      "SecurityLevel": 0,
      "WorkName": "asdas",
      "WorkspaceName": "asdas",
      "WorksId": "ccd3428c-****-****-a608-26bae29dffee",
      "Directory": {
        "PathId": "88b680****",
        "Id": "a3eecab7-618d-4f9f-*****",
        "PathName": "asdas/safas",
        "Name": "asdas"
      }
    }
  ]
}

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.

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