All Products
Search
Document Center

Quick BI:QuerySharesToUserList

Last Updated:Apr 17, 2025

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
quickbi-public:QuerySharesToUserListlist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserIdstringYes

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

ParameterTypeDescriptionExample
object
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
RequestIdstring

The ID of the request.

DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Resultarray<object>

Returns a list of works authorized to the user.

Dataobject
Statusinteger

The publishing status of the report. Valid values:

  • 0: unpublished
  • 1: published
  • 2: modified but not published
  • 3: unpublished
1
ThirdPartAuthFlaginteger

Third-party embedding status. Valid values:

  • 0: No embedding is enabled.
  • 1: Embed is enabled.
0
WorksIdstring

The ID of the operations report.

97f7f4c1-543a-4069-8e8d-a56cfcd6****
CreateTimestring

The timestamp of the creation time in milliseconds.

1530078690000
WorkTypestring

The type of the work. Valid values:

  • DATAPRODUCT: BI portal
  • PAGE: Dashboard
  • FULLPAGE: full-screen dashboards
  • REPORT: workbook
  • dashboardOfflineQuery: self-service data retrieval
DATAFORM
OwnerNamestring

The Alibaba Cloud account name of the work owner.

w****@aliyun.com
WorkspaceNamestring

The name of the workspace to which the report belongs.

Return to Professional Edition
OwnerIdstring

The UserID of the work owner in Quickbi.

74f5527216d14e9892245320ebf2****
ModifyNamestring

The name of the Alibaba Cloud account to which the modifier belongs.

13855265****@163.com
WorkspaceIdstring

The ID of the workspace to which the report belongs.

c5f86ad2-ef53-4c51-8720-162ecfdb****
SecurityLevelstring

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
Descriptionstring

Remarks on the work.

Description of the test report
WorkNamestring

The name of the report.

Test report
ModifyTimestring

The timestamp of the modification time in milliseconds.

1530078690000
Directoryobject

Information about the directory where the work is located.

PathIdstring

The path ID of the directory where the resource is located.

66ffe22b-83be-47fd-b49d-9ca58d29****/f7f6e22b-83be-47fd-b49d-9ca686a9****
PathNamestring

The path name of the directory where the resource is located.

Level -1 Directory /Level -2 Directory
Namestring

The name of the resource.

Chart Report
Idstring

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 codeError codeError messageDescription
400Instance.ExpiredYour instance has expired.Your instance has expired.
400Instance.Not.ExistThe specified instance does not exist.The specified instance does not exist.
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.The specified organizational unit does not exist.
400User.Not.In.OrganizationThe specified user is not in the organizational unit.The specified user is not in the organizational unit.
400Internal.System.ErrorAn internal system error occurred.An internal system error occurred.
400Invalid.ParameterAn error occurred while verifying parameters.An error occurred while verifying parameters.
400Invalid.Parameter.ErrorThe parameter is invalid:%s.invalid parameter: ${0}.
400Invalid.Param.ErrorThe parameter is invalid.The parameter is invalid.
400Invalid.User.AdminYou are not an administrator of this organization.Only organization administrators can perform this operation.
400System.Param.EmptyYou must specify the %s parameter.You must specify the %s parameter.
400UserInfo.ErrorThe personal information is invalid.The personal information is invalid.
400ApiUser.Not.ExistsThe specified user does not exist.The specified user does not exist.

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