QueryReadableResourcesListByUserId接口用于查询用户有权查看的作品列表,包含空间下与分享授权的报表。

请求参数

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

要执行的操作。取值:QueryReadableResourcesListByUserId

UserId String de4bc5f9429141cc8091cdd1c15b****

Quick BI用户ID。

返回数据

名称 类型 示例值 描述
Success Boolean true

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

  • true:请求成功
  • false:请求失败
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。

Result Array of Data

用户有权限查看的作品列表。

Status Integer 1

报表状态。取值范围:

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

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

  • 0:暂未开通嵌入
  • 1:已开通嵌入
WorksId String 03366b16-69ce-43c8-b782-56c2f6ec****

作品ID。

CreateTime String 1611023338000

创建时间的毫秒级时间戳。

WorkType String PAGE

作品类型。取值范围:

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • FULLPAGE:全屏仪表板
  • REPORT:电子表格
OwnerName String 张三

所有者的阿里云账户名。

WorkspaceName String 测试工作空间

作品所属工作空间名称。

OwnerId String 46e5374665ba4b679ee22e2a2927****

作品所有者的Quick BI的UserID。

ModifyName String 李四

修改者的阿里云账户名。

WorkspaceId String 89713491-cb4f-4579-b889-e82c35f1****

作品所属工作空间ID。

SecurityLevel String 0

作品协同授权的安全策略。取值:

  • 0:私密
  • 12:授权指定成员
  • 1或11:授权所有空间成员
说明
  • 若您使用旧版权限,则返回值为1。
  • 若您使用新版权限,则返回值为11。
Description String 备注

作品备注。

WorkName String 公司地区表

作品名称。

ModifyTime String 1611023338000

修改时间的毫秒级时间戳。

Directory Object

作品所处的目录结构。

PathId String e4276ea5-b232-4fb1-8f0f-efcee4a2****

目录ID的层级结构,以『/』分隔。

PathName String 测试目录

目录名称的层级结构,以『/』分隔。

Name String 测试目录

所属目录名称。

Id String e4276ea5-b232-4fb1-8f0f-efcee4a2****

所属目录ID。

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=QueryReadableResourcesListByUserId
&UserId=de4bc5f9429141cc8091cdd1c15b****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryReadableResourcesListByUserIdResponse>
    <Success>true</Success>
    <RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
    <Result>
        <Status>1</Status>
        <ThirdPartAuthFlag>1</ThirdPartAuthFlag>
        <WorksId>03366b16-69ce-43c8-b782-56c2f6ec****</WorksId>
        <CreateTime>1611023338000</CreateTime>
        <WorkType>PAGE</WorkType>
        <OwnerName>张三</OwnerName>
        <WorkspaceName>测试工作空间</WorkspaceName>
        <OwnerId>46e5374665ba4b679ee22e2a2927****</OwnerId>
        <ModifyName>李四</ModifyName>
        <WorkspaceId>89713491-cb4f-4579-b889-e82c35f1****</WorkspaceId>
        <SecurityLevel>0</SecurityLevel>
        <Description>备注</Description>
        <WorkName>公司地区表</WorkName>
        <ModifyTime>1611023338000</ModifyTime>
        <Directory>
            <PathId>e4276ea5-b232-4fb1-8f0f-efcee4a2****</PathId>
            <PathName>测试目录</PathName>
            <Name>测试目录</Name>
            <Id>e4276ea5-b232-4fb1-8f0f-efcee4a2****</Id>
        </Directory>
    </Result>
</QueryReadableResourcesListByUserIdResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "RequestId" : "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result" : [ {
    "Status" : 1,
    "ThirdPartAuthFlag" : 1,
    "WorksId" : "03366b16-69ce-43c8-b782-56c2f6ec****",
    "CreateTime" : "1611023338000",
    "WorkType" : "PAGE",
    "OwnerName" : "张三",
    "WorkspaceName" : "测试工作空间",
    "OwnerId" : "46e5374665ba4b679ee22e2a2927****",
    "ModifyName" : "李四",
    "WorkspaceId" : "89713491-cb4f-4579-b889-e82c35f1****",
    "SecurityLevel" : "0",
    "Description" : "备注",
    "WorkName" : "公司地区表",
    "ModifyTime" : "1611023338000",
    "Directory" : {
      "PathId" : "e4276ea5-b232-4fb1-8f0f-efcee4a2****",
      "PathName" : "测试目录",
      "Name" : "测试目录",
      "Id" : "e4276ea5-b232-4fb1-8f0f-efcee4a2****"
    }
  } ]
}

错误码

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. 系统内部异常。

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