QuerySharesToUserList接口用于查询授权给用户的作品列表。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QuerySharesToUserList

要执行的操作。取值：QuerySharesToUserList。
UserId String 是 46e5374665ba4b679ee22e2a2927****

用户ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。

返回数据

名称 类型 示例值 描述
RequestId String DC4E1E63-B337-44F8-8C22-6F00DF67E2C3

请求ID。
Result Array of Data

返回授权给用户的作品列表。
CreateTime String 1530078690000

创建时间的毫秒级时间戳。
Description String 测试报表的描述

作品备注。
Directory Struct

作品所在的目录信息。
Id String f7f6e22b-83be-47fd-b49d-9ca686a9****

资源所在的目录ID。
Name String 图表报表

资源名称。
PathId String 66ffe22b-83be-47fd-b49d-9ca58d29****/f7f6e22b-83be-47fd-b49d-9ca686a9****

资源所在目录的路径ID。
PathName String 一级目录/二级目录

资源所在目录的路径名称。
ModifyName String 13855265****@163.com

修改者的阿里云账户名。
ModifyTime String 1530078690000

修改时间的毫秒级时间戳。
OwnerId String 74f5527216d14e9892245320ebf2****

作品所有者在Quickbi 的UserID。
OwnerName String w****@aliyun.com

作品所有者的阿里云账户名。
SecurityLevel String 0

安全策略。取值范围：

  • 0：私有
  • 1：协同编辑
Status Integer 1

报表的发布状态。取值范围：

  • 0：未发布
  • 1：已发布
  • 2：已修改未发布
  • 3：已下线
ThirdPartAuthFlag Integer 0

第三方嵌入状态。取值范围：

  • 0：未开通嵌入
  • 1：已开通嵌入
WorkName String 测试报表

报表名称。
WorkType String DATAFORM

作品类型。取值范围：

  • DATAPRODUCT：数据门户
  • PAGE：仪表板
  • FULLPAGE：全屏仪表板
  • REPORT：电子表格
  • dashboardOfflineQuery：自助取数
WorksId String 97f7f4c1-543a-4069-8e8d-a56cfcd6****

报表ID。
WorkspaceId String c5f86ad2-ef53-4c51-8720-162ecfdb****

报表所在工作空间的ID。
WorkspaceName String 专业版回归

报表所在工作空间的名称。
Success Boolean true

是否请求成功。取值范围：

  • true：请求成功
  • false：请求失败

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=QuerySharesToUserList
&UserId=46e5374665ba4b679ee22e2a2927****
&<公共请求参数>

正常返回示例

XML格式 

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

JSON格式 

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

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止，您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

访问错误中心查看更多错误码。