QueryWorksByWorkspace接口用于获取组织下某个工作空间下的所有作品，可指定作品类型。

请求参数

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

要执行的操作。取值：QueryWorksByWorkspace。

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

工作空间ID。
WorksType String 否 PAGE

作品类型。取值范围：

  • DATAPRODUCT：数据门户
  • PAGE：仪表板
  • FULLPAGE：全屏仪表板
  • REPORT：电子表格
Status Integer 否 0

作品状态。取值范围：

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

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

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

页码。

  • 默认值1。
PageSize Integer 否 10

每页行数。

  • 默认值10。

返回数据

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

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

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

请求ID。
Result Object

返回组织工作空间下所有符合请求条件的作品列表。
TotalPages Integer 1

总页码。
PageNum Integer 1

页码。
PageSize Integer 10

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

总行数。
Data Array of Data

作品列表详情。
Status Integer 1

报表状态。取值范围：

  • 0：未发布
  • 1：已发布
  • 2：已修改未发布
  • 3：已下线
GmtModify String 1572334870000

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

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

  • 0：暂未开通嵌入
  • 1：已开通嵌入
WorksId String 897ce25e-f993-4abd-af84-d13c5610****

作品ID。
WorkType String PAGE

作品类型。取值范围：

  • DATAPRODUCT：数据门户
  • PAGE：仪表板
  • FULLPAGE：全屏仪表板
  • REPORT：电子表格
OwnerName String 李四

作品所有者的昵称。
WorkspaceName String 测试工作空间

作品所属工作空间名称。
OwnerId String 9187a612aa474e2a8ac1414d5529****

作品所有者在Quick BI的UserID。
ModifyName String 张三

作品修改者的昵称。
WorkspaceId String 87c6b145-090c-43e1-9426-8f93be23****

作品所属工作空间的ID。
SecurityLevel String 0

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

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

作品备注。
WorkName String 测试报表

作品名称。
GmtCreate String 1496651577000

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

作品所属目录。
PathId String 83d37ba6-d909-48a2-a517-f4d05c3a****

所属目录ID的层级结构，以『/』分隔。
PathName String 测试目录

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

所属目录名称。
Id String 83d37ba6-d909-48a2-a517-f4d05c3a****

所属目录ID。

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=QueryWorksByWorkspace
&WorkspaceId=89713491-cb4f-4579-b889-e82c35f1****
&WorksType=PAGE
&Status=0
&ThirdPartAuthFlag=0
&PageNum=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式 

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

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

JSON格式 

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

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

错误码

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. 系统内部异常。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。

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