QueryWorksByOrganization接口用于获取整个组织下的所有作品,可指定作品类型。

请求参数

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

要执行的操作。取值:QueryWorksByOrganization。

WorksType String PAGE

查询作品的类型,填空为查询所有类型。取值范围:

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • FULLPAGE:全屏仪表板
  • REPORT:电子表格
  • dashboardOfflineQuery:自助取数
Status Integer 0

查询作品的状态。取值范围:

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

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

  • 0:暂未开通嵌入
  • 1:已开通嵌入
PageNum Integer 1

页码。

PageSize Integer 10

每页行数。

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。

Result Struct

返回组织下所有符合请求条件的作品列表。

Data Array of Data

作品列表详情。

Auth3rdFlag Integer 0

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

  • 0:暂未开通嵌入
  • 1:已开通嵌入
Description String 备注

作品备注。

Directory Struct

作品所属目录。

Id String 83d37ba6-d909-48a2-a517-f4d05c3a****

所属目录ID。

Name String 测试目录

所属目录名称。

PathId String 83d37ba6-d909-48a2-a517-f4d05c3a****

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

PathName String 测试目录

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

GmtCreate String 1496651577000

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

GmtModify String 1572334870000

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

ModifyName String 张三

作品修改者的阿里云账户名。

OwnerId String 9187a612aa474e2a8ac1414d5529****

作品所有者在Quick BI的UserID。

OwnerName String 李四

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

SecurityLevel String 0

作品的安全策略。取值范围:

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

报表状态。取值范围:

  • 0:未发布
  • 1:已发布
  • 2:已修改未发布
  • 3:已下线
WorkName String 测试报表

作品名称。

WorkType String PAGE

作品类型。取值范围:

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • FULLPAGE:全屏仪表板
  • REPORT:电子表格
WorksId String 897ce25e-f993-4abd-af84-d13c5610****

作品ID。

WorkspaceId String 87c6b145-090c-43e1-9426-8f93be23****

作品所属工作空间的ID。

WorkspaceName String 测试工作空间

作品所属工作空间名称。

PageNum Integer 1

页码。

PageSize Integer 10

请求接口时设置的每页行数。

TotalNum Integer 1

总行数。

TotalPages Integer 1

总页数。

Success Boolean true

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

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

示例

请求示例

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

正常返回示例

XML格式

<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>
    <TotalNum>10</TotalNum>
    <PageSize>10</PageSize>
    <PageNum>1</PageNum>
    <TotalPages>1</TotalPages>
    <Data>
        <Status>0</Status>
        <OwnerName>李四</OwnerName>
        <Description>备注</Description>
        <WorkType>PAGE</WorkType>
        <ModifyName>张三</ModifyName>
        <WorkspaceId>87c6b145-090c-43e1-9426-8f93be23****</WorkspaceId>
        <Auth3rdFlag>0</Auth3rdFlag>
        <GmtCreate>1496651577000</GmtCreate>
        <OwnerId>9187a612aa474e2a8ac1414d5529****</OwnerId>
        <GmtModify>1572334870000</GmtModify>
        <WorkName>测试报表</WorkName>
        <SecurityLevel>0</SecurityLevel>
        <WorkspaceName>测试工作空间</WorkspaceName>
        <WorksId>897ce25e-f993-4abd-af84-d13c5610****</WorksId>
    </Data>
    <Data>
        <Directory>
            <PathId>83d37ba6-d909-48a2-a517-f4d05c3a****</PathId>
            <PathName>测试目录</PathName>
            <Id>83d37ba6-d909-48a2-a517-f4d05c3a****</Id>
            <Name>测试目录</Name>
        </Directory>
    </Data>
</Result>

JSON格式

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":{"TotalNum":"10","PageSize":"10","PageNum":"1","TotalPages":"1","Data":[{"Status":"0","OwnerName":"李四","Description":"备注","WorkType":"PAGE","ModifyName":"张三","WorkspaceId":"87c6b145-090c-43e1-9426-8f93be23****","Auth3rdFlag":"0","GmtCreate":"1496651577000","OwnerId":"9187a612aa474e2a8ac1414d5529****","GmtModify":"1572334870000","WorkName":"测试报表","SecurityLevel":"0","WorkspaceName":"测试工作空间","WorksId":"897ce25e-f993-4abd-af84-d13c5610****"},{"Directory":{"PathId":"83d37ba6-d909-48a2-a517-f4d05c3a****","PathName":"测试目录","Id":"83d37ba6-d909-48a2-a517-f4d05c3a****","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 Invalid.Param.Error The parameter is invalid. 无效参数。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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