Query works authorized to a user with QuerySharesToUserList - Quick BI - Alibaba Cloud - Quick BI

Queries the list of works authorized to a specified user.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The ID of the user. This is the Quick BI UserID, not the Alibaba Cloud UID.	46e53**5ba4b679ee22e2a2927**

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.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	array<object>	The list of works authorized to the user.
	array<object>
CreateTime	string	The creation time. Unit: milliseconds.	1530078690000
Description	string	Remarks on the work.	测试报表的描述
Directory	object	The directory where the work is located.
Id	string	The ID of the directory where the resource is located.	f7f6e22b-83be-47fd-b49d-9ca686a9****
Name	string	The name of the resource.	图表报表
PathId	string	The path ID of the directory where the resource is located.	66ffe22b-83be-47fd-b49d-9ca58d29**/f7f6e22b-83be-47fd-b49d-9ca686a9**
PathName	string	The path name of the directory where the resource is located.	一级目录/二级目录
ModifyName	string	The Alibaba Cloud account name of the modifier.	13855265****@163.com
ModifyTime	string	The modification time. Unit: milliseconds.	1530078690000
OwnerId	string	The Quick BI user ID of the work owner.	74f5527216d14e9892245320ebf2****
OwnerName	string	The Alibaba Cloud account name of the work owner.	w****@aliyun.com
SecurityLevel	string	The security policy 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 publishing status of the work. Valid values: 0: unpublished 1: published 2: modified but not published 3: unpublished	1
ThirdPartAuthFlag	integer	Third-party embedding status. Valid values: 0: No embedding is enabled. 1: Embed is enabled.	0
WorkName	string	The name of the report.	测试报表
WorkType	string	The type of the work. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard FULLPAGE: full-screen dashboards REPORT: workbook dashboardOfflineQuery: self-service data retrieval	DATAFORM
WorksId	string	The ID of the operations report.	97f7f4c1-543a-4069-8e8d-a56cfcd6****
WorkspaceId	string	The ID of the workspace to which the report belongs.	c5f86ad2-ef53-4c51-8720-162ecfdb****
WorkspaceName	string	The name of the workspace to which the report belongs.	专业版回归

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": [
    {
      "CreateTime": "1530078690000",
      "Description": "测试报表的描述",
      "Directory": {
        "Id": "f7f6e22b-83be-47fd-b49d-9ca686a9****",
        "Name": "图表报表",
        "PathId": "66ffe22b-83be-47fd-b49d-9ca58d29****/f7f6e22b-83be-47fd-b49d-9ca686a9****",
        "PathName": "一级目录/二级目录"
      },
      "ModifyName": "13855265****@163.com",
      "ModifyTime": "1530078690000",
      "OwnerId": "74f5527216d14e9892245320ebf2****",
      "OwnerName": "w****@aliyun.com",
      "SecurityLevel": "0",
      "Status": 1,
      "ThirdPartAuthFlag": 0,
      "WorkName": "测试报表",
      "WorkType": "DATAFORM",
      "WorksId": "97f7f4c1-543a-4069-8e8d-a56cfcd6****",
      "WorkspaceId": "c5f86ad2-ef53-4c51-8720-162ecfdb****",
      "WorkspaceName": "专业版回归"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.