QueryWorks接口用于查询指定报表的信息。

请求参数

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

要执行的操作。取值：QueryWorks。
WorksId String 是 abcd****

报表ID。

返回数据

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

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

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

请求ID。
Result Object

作品详情信息。
WorksId String 95296e95-ca89-4c7d-8af9-dedf0ad0****

作品ID。
WorkType String PAGE

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

  • DATAPRODUCT：数据门户
  • PAGE：仪表板
  • FULLPAGE：全屏仪表板
  • REPORT：电子表格
  • dashboardOfflineQuery：自助取数
WorkName String 测试报表

作品名称。
WorkspaceId String 87c6b145-090c-43e1-9426-8f93be23****

作品所属工作空间的ID。
WorkspaceName String 测试空间

作品所属工作空间名称。
Directory Object

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

所属目录ID。
Name String 测试目录

目录名称。
PathId String 83d37ba6-d909-48a2-a517-f4d05c3a****

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

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

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

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

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

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

作品备注。
OwnerId String 9187a612aa474e2a8ac1414d5529****

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

作品所有者的阿里云账户名。
ModifyName String 李四

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

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

作品修改的毫秒级时间戳
Status Integer 0

报表状态。取值范围：

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

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=QueryWorks
&WorksId=abcd****
&公共请求参数

正常返回示例

XML格式 

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

<QueryWorksResponse>
    <Success>true</Success>
    <RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
    <Result>
        <WorksId>95296e95-ca89-4c7d-8af9-dedf0ad0****</WorksId>
        <WorkType>PAGE</WorkType>
        <WorkName>测试报表</WorkName>
        <WorkspaceId>87c6b145-090c-43e1-9426-8f93be23****</WorkspaceId>
        <WorkspaceName>测试空间</WorkspaceName>
        <Directory>
            <Id>83d37ba6-d909-48a2-a517-f4d05c3a****</Id>
            <Name>测试目录</Name>
            <PathId>83d37ba6-d909-48a2-a517-f4d05c3a****</PathId>
            <PathName>测试目录</PathName>
        </Directory>
        <SecurityLevel>0</SecurityLevel>
        <Auth3rdFlag>0</Auth3rdFlag>
        <Description>备注</Description>
        <OwnerId>9187a612aa474e2a8ac1414d5529****</OwnerId>
        <OwnerName>张三</OwnerName>
        <ModifyName>李四</ModifyName>
        <GmtCreate>1496651577000</GmtCreate>
        <GmtModify>1496651577000</GmtModify>
        <Status>0</Status>
    </Result>
</QueryWorksResponse>

JSON格式 

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

{
  "Success" : true,
  "RequestId" : "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result" : {
    "WorksId" : "95296e95-ca89-4c7d-8af9-dedf0ad0****",
    "WorkType" : "PAGE",
    "WorkName" : "测试报表",
    "WorkspaceId" : "87c6b145-090c-43e1-9426-8f93be23****",
    "WorkspaceName" : "测试空间",
    "Directory" : {
      "Id" : "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "Name" : "测试目录",
      "PathId" : "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "PathName" : "测试目录"
    },
    "SecurityLevel" : "0",
    "Auth3rdFlag" : 0,
    "Description" : "备注",
    "OwnerId" : "9187a612aa474e2a8ac1414d5529****",
    "OwnerName" : "张三",
    "ModifyName" : "李四",
    "GmtCreate" : "1496651577000",
    "GmtModify" : "1496651577000",
    "Status" : 0
  }
}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止，您的实例版本或者 AccessKey不允许调用该 API。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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