QuerySharesToUserList - Quick BI - Alibaba Cloud Documentation Center

You can call this operation to query the list of works authorized to a user.

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

There is currently no authorization information disclosed in the API.

Request parameters

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

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.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	array<object>	Returns a list of works authorized to the user.
Data	object
Status	integer	The publishing 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: No embedding is enabled. 1: Embed is enabled.	0
WorksId	string	The ID of the operations report.	97f7f4c1-543a-4069-8e8d-a56cfcd6****
CreateTime	string	The timestamp of the creation time in milliseconds.	1530078690000
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
OwnerName	string	The Alibaba Cloud account name of the work owner.	w****@aliyun.com
WorkspaceName	string	The name of the workspace to which the report belongs.	Return to Professional Edition
OwnerId	string	The UserID of the work owner in Quickbi.	74f5527216d14e9892245320ebf2****
ModifyName	string	The name of the Alibaba Cloud account to which the modifier belongs.	13855265****@163.com
WorkspaceId	string	The ID of the workspace to which the report belongs.	c5f86ad2-ef53-4c51-8720-162ecfdb****
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
Description	string	Remarks on the work.	Description of the test report
WorkName	string	The name of the report.	Test report
ModifyTime	string	The timestamp of the modification time in milliseconds.	1530078690000
Directory	object	Information about the directory where the work is located.
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.	Level -1 Directory /Level -2 Directory
Name	string	The name of the resource.	Chart Report
Id	string	The ID of the directory where the resource is located.	f7f6e22b-83be-47fd-b49d-9ca686a9****

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": [
    {
      "Status": 1,
      "ThirdPartAuthFlag": 0,
      "WorksId": "97f7f4c1-543a-4069-8e8d-a56cfcd6****",
      "CreateTime": "1530078690000",
      "WorkType": "DATAFORM",
      "OwnerName": "w****@aliyun.com",
      "WorkspaceName": "Return to Professional Edition\n",
      "OwnerId": "74f5527216d14e9892245320ebf2****",
      "ModifyName": "13855265****@163.com",
      "WorkspaceId": "c5f86ad2-ef53-4c51-8720-162ecfdb****",
      "SecurityLevel": "0",
      "Description": "Description of the test report\n",
      "WorkName": "Test report\n",
      "ModifyTime": "1530078690000",
      "Directory": {
        "PathId": "66ffe22b-83be-47fd-b49d-9ca58d29****/f7f6e22b-83be-47fd-b49d-9ca686a9****",
        "PathName": "Level -1 Directory /Level -2 Directory\n",
        "Name": "Chart Report\n",
        "Id": "f7f6e22b-83be-47fd-b49d-9ca686a9****"
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Instance.Expired	Your instance has expired.	Your instance has expired.
400	Instance.Not.Exist	The specified instance does not exist.	The specified instance does not exist.
400	Access.Forbidden	Access forbidden. Your instance version or access key is not allowed to call the API operation.	-
400	Invalid.Organization	The specified organizational unit does not exist.	The specified organizational unit does not exist.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Invalid.Parameter	An error occurred while verifying parameters.	An error occurred while verifying parameters.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
400	Invalid.Param.Error	The parameter is invalid.	The parameter is invalid.
400	Invalid.User.Admin	You are not an administrator of this organization.	Only organization administrators can perform this operation.
400	System.Param.Empty	You must specify the %s parameter.	You must specify the %s parameter.
400	UserInfo.Error	The personal information is invalid.	The personal information is invalid.
400	ApiUser.Not.Exists	The specified user does not exist.	The specified user does not exist.

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