报表资源管理-阿里云帮助中心

本文为您介绍报表资源下的API接口。

查询组织下的所有作品

接口路径：/openapi/v2/works （GET）
接口描述：获取整个组织下的所有作品，可限定作品类型。

输入参数：/openapi/v2/works?worksType=

参数	类型	描述	是否必需
worksType	string	查询参数，所查询报表类型，填空为查询所有类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表板 REPORT：电子表格 dashboardOfflineQuery：自助取数 DATAFORM：数据填报 ANALYSIS：即席分析 SCREEN：数据大屏	否
auth3rdFlag	int	查询参数，所查报表的第三方嵌入状态。取值范围： 0：暂未开通嵌入 1：已开通嵌入起始版本：独立部署3.6	否
status	int	查询参数，报表的发布状态。不传，则所查结果不区分状态。取值范围： 0：未发布 1：已发布 2: 已修改未发布 3: 已下线起始版本：独立部署3.8	否

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object [ ]	返回作品列表。
status	int	报表的发布状态。独立部署3.8新增，取值范围： 0：未发布 1：已发布 2：已修改未发布 3：已下线示例值：1
auth3rdFlag	int	第三方嵌入状态。独立部署3.6新增，取值范围： 0：未开通嵌入 1：已开通嵌入示例值：0
worksId	string	报表ID。示例值：97f7f4c1-543a-4069-8e8d-a56cfcd6****
createTime	string	创建时间的毫秒级时间戳。示例值：1530078690000
workType	string	作品类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表 REPORT：电子表格 dashboardOfflineQuery：自助取数示例值：DATAFORM
ownerName	string	作品所有者的账号名。示例值：w****@aliyun.com
accountName	string	作品所有者的账号名。示例值：w****@aliyun.com
workspaceName	string	报表所在工作空间的名称（独立部署3.8.4新增）。示例值：专业版回归
ownerId	string	作品所有者在Quickbi 的UserID。示例值：74f5527216d14e9892245320ebf2****
modifyName	string	修改者的账号名。示例值：13855265****@163.com
workspaceId	string	报表所在工作空间的ID。示例值：c5f86ad2-ef53-4c51-8720-162ecfdb****
securityLevel	string	作品协同授权的安全策略。取值： 0：私密 12：授权指定成员 1或11：授权所有空间成员说明若您使用旧版权限，则返回值为1。若您使用新版权限，则返回值为11。示例值：0
description	string	作品备注。示例值：测试报表的描述
workName	string	报表名称。示例值：测试报表
modifyTime	string	修改时间的毫秒级时间戳。示例值：1530078690000
draftViewUrl	string	仪表板草稿态的预览链接注意： 1、仅对仪表板生效； 2、当组织开启报表的编辑态「允许复制预览链接」功能时，才会返回该项参数值。
directory	object	作品所在的目录信息（独立部署3.8.4新增）。作品位于根目录时不返回
pathId	string	资源所在目录的路径ID。示例值：66ffe22b-83be-47fd-b49d-9ca58d29**/f7f6e22b-83be-47fd-b49d-9ca686a9**
pathName	string	资源所在目录的路径名称。示例值：一级目录/二级目录
name	string	资源名称。示例值：图表报表
id	string	资源所在的目录ID。示例值：f7f6e22b-83be-47fd-b49d-9ca686a9****
publicFlag	boolean	是否公开
publicInvalidTime	integer	报表公开的截止日期
formFillingStatus	boolean	该电子表格中是否配置了表格填报。起始版本：独立部署v5.4.1

返回参数：

{
    "traceId": "284d25a9-34f0-****-8f76-98b1aeba766d",
    "code": null,
    "message": null,
    "data": [
        {
            "worksId": "f3bf46a8-****", 
            "workType": "PAGE",
            "workName": "报表名称",
            "workspaceId": "87c6b145-****",
            "workspaceName": "xxxxx",
            "securityLevel": "0",
            "auth3rdFlag":0,
            "description": null, 
            "ownerId": "363e8880****",
            "accountName": null,
            "ownerName": "cat4***@aliyun.com",
            "modifyName": null,
            "gmtCreate": 1484818350000,
            "gmtModify": 1557823287000,
            "draftViewUrl": "**/dashboard/view/pc.htm?pageId=cd1234f-321cs342-4sd31**&previewDraft=true",
            "status":1,
            "directory":{ 
            		"id":"31a87ad2-***",
                    "name":"二级目录",
                    "pathId":"38b2796c-***/31a87ad2-***",
            		"pathName":"一级目录名称/二级目录名称"
       		},
            "publicFlag": true,
            "publicInvalidTime": 1721366354000,
            "formFillingStatus": false
        }
    ],
    "success": true
}

JAVA SDK 示例：

public static void getWorksByOrganization() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/works")
        .setMethod(HttpMethod.GET);
    // 非必填参数
    // request.addParameter("worksType","xxx");
    // request.addParameter("status","xxx");
    // request.addParameter("auth3rdFlag","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

查询工作空间下的所有作品

接口路径：/openapi/v2/works/{workspaceId} （GET）
接口描述：获取某个工作空间下的所有作品，可限定作品类型。

输入参数：/openapi/v2/works/{workspaceId}?worksType=

参数	类型	描述	是否必需
workspaceId	string	路径参数，所查询的工作空间ID。	是
worksType	string	查询参数，所查询报表类型，填空为查询所有类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表板 REPORT：电子表格 dashboardOfflineQuery：自助取数 DATAFORM：数据填报 ANALYSIS：即席分析 SCREEN：数据大屏	否
auth3rdFlag	int	查询参数，所查报表的第三方嵌入状态。取值范围： 0：暂未开通嵌入 1：已开通嵌入说明独立部署3.6版本后，新增或更新过本参数。	否
status	int	查询参数，报表的发布状态。不传，则所查结果不区分状态。 0：未发布 1：已发布 2：已修改未发布 3：已下线说明独立部署3.8版本后，新增或更新过本参数。	否

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object []	返回作品列表。
status	int	报表的发布状态。独立部署3.8新增，取值范围： 0：未发布 1：已发布 2：已修改未发布 3：已下线示例值：1
auth3rdFlag	int	第三方嵌入状态。独立部署3.6新增，取值范围： 0：未开通嵌入 1：已开通嵌入示例值：0
worksId	string	报表ID。示例值：97f7f4c1-543a-4069-8e8d-a56cfcd6****
createTime	string	创建时间的毫秒级时间戳。示例值：1530078690000
workType	string	作品类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表 REPORT：电子表格 dashboardOfflineQuery：自助取数示例值：DATAFORM
ownerName	string	作品所有者的账号名。示例值：w****@aliyun.com
accountName	string	作品所有者的账号名。示例值：w****@aliyun.com
workspaceName	string	报表所在工作空间的名称（独立部署3.8.4新增）。示例值：专业版回归
ownerId	string	作品所有者在Quickbi的UserID。示例值：74f5527216d14e9892245320ebf2****
modifyName	string	修改者的账号名。示例值：13855265****@163.com
workspaceId	string	报表所在工作空间的ID。示例值：c5f86ad2-ef53-4c51-8720-162ecfdb****
securityLevel	string	作品协同授权的安全策略。取值： 0：私密 12：授权指定成员 1或11：授权所有空间成员说明若您使用旧版权限，则返回值为1。若您使用新版权限，则返回值为11。示例值：0
description	string	作品备注。示例值：测试报表的描述
workName	string	报表名称。示例值：测试报表
modifyTime	string	修改时间的毫秒级时间戳。示例值：1530078690000
draftViewUrl	string	仪表板草稿态的预览链接重要 1.仅对仪表板生效； 2.当组织开启报表的编辑态「允许复制预览链接」功能时，才会返回该项参数值。
directory	object	作品所在的目录信息（独立部署3.8.4新增）。作品位于根目录时不返回
pathId	string	资源所在目录的路径ID。示例值：66ffe22b-83be-47fd-b49d-9ca58d29**/f7f6e22b-83be-47fd-b49d-9ca686a9**
pathName	string	资源所在目录的路径名称。示例值：一级目录/二级目录
name	string	资源名称。示例值：图表报表
id	string	资源所在的目录ID。示例值：f7f6e22b-83be-47fd-b49d-9ca686a9****
publicFlag	boolean	是否公开
publicInvalidTime	integer	报表公开的截止日期
formFillingStatus	boolean	该电子表格中是否配置了表格填报。起始版本：独立部署v5.4.1

返回参数：

{
    "traceId": "284d25a9-34f0-****-8f76-98b1aeba766d",
    "code": null,
    "message": null,
    "data": [
        {
            "worksId": "f3bf46a8-****",
            "workType": "PAGE",
            "workName": "报表名称",
            "workspaceId": "87c6b145-****",
            "workspaceName": "xxxxx",
            "securityLevel": "0",
            "auth3rdFlag":0, 
            "description": null, 
            "ownerId": "363e****0032",
            "accountName": "cat4***@aliyun.com",
            "ownerName": "cat4***@aliyun.com",
            "modifyName": null,
            "gmtCreate": 1484818350000,
            "gmtModify": 1557823287000,
            "status":1,
            "directory":{
                "id":"31a87ad2-***",
                "name":"二级目录",
                "pathId":"38b2796c-***/31a87ad2-***",
                "pathName":"一级目录名称/二级目录名称"
       		},
            "publicFlag": true,
            "publicInvalidTime": 1721366354000,
            "formFillingStatus": true
        }
    ],
    "success": true
}

JAVA SDK 示例：

public static void getWorksByWorkspace() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/works/{workspaceId}")
        .setMethod(HttpMethod.GET);
    // 非必填参数
    // request.addParameter("worksType","xxx");
    // request.addParameter("status","xxx");
    // request.addParameter("auth3rdFlag","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

查询用户有权查看的作品列表（不包含菜单授权）

接口路径：/openapi/v2/works/readable/user/{userId}/list （GET）
接口描述：查询用户有权查看的作品列表，包含空间下与分享授权的报表。
重要
注意：当前接口已过期，不再迭代和维护，请使用查询用户有权查看的作品列表接口进行替换。
输入参数：
参数
类型
描述
是否必需
userId
string
路径参数，需要查询的用户。
是

返回参数说明（SDK调用时，仅返回data部分）：

参数	数据类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	list	返回接口执行结果。
worksId	string	作品ID。
workType	string	作品类型。
workName	string	作品名称。
workspaceId	string	所属工作空间。
securityLevel	string	安全策略：0 私有 1 协同编辑。
description	string	描述。
ownerId	string	所有者Id。
accountName	string	所有者账户名称。
ownerName	string	所有者显示名称。
modifyName	string	修改显示名称。
gmtCreate	string	创建时间d。
gmtModify	string	修改时间。
auth3rdFlag	integer	第三方嵌入状态（独立部署3.6新增）。
status	integer	报表发布状态（独立部署3.7新增）。
workspaceName	string	所属空间名称（独立部署3.8.4新增）。
draftViewUrl	string	仪表板草稿态的预览链接注意： 1、仅对仪表板生效； 2、当组织开启报表的编辑态「允许复制预览链接」功能时，才会返回该项参数值。
directory	string [ ]	所属空间目录信息（独立部署3.8.4新增）。
id	string	目录ID。
name	string	目录名称。
pathId	string	目录ID的路径，例如：aa/bb/cc/dd。
pathName	string	目录ID的路径名称，例如：一层目录/二层目录。
worksCubeModels	object [ ]	对应数据集信息。

返回参数：

{
    "traceId": "284d25a9-34f0-****-8f76-98b1aeba766d",
    "code": null,
    "message": null,
    "data": [
        {
            "worksId": "f3bf46a8-****",  // 报表ID
            "workType": "PAGE",          // 报表类型 
                                         // DATAPRODUCT：数据门户
                                         // PAGE：仪表板
                                         // FULLPAGE：全屏仪表板[备注]
                                         // REPORT：电子表格
                                         // dashboardOfflineQuery：自助取数
            "workName": "报表名称",       // 报表名称
            "workspaceId": "87c6b145-090c",   // 所属空间 ID
            "workspaceName": "xxxxx",         // 所属空间名称
            "securityLevel": "0",         // 安全策略：0 私有 1 协同编辑
            "auth3rdFlag":0,              // 第三方嵌入状态，0：暂未开通嵌入  1：已开通嵌入  @since3.6
            "description": null, 
            "ownerId": "363e****0032",    // 报表 ownerId
            "ownerName": "a***@example.com", // 报表 ownerName
            "modifyName": null,
            "gmtCreate": 1484****50000,    // 报表创建时间
            "gmtModify": 1557****87000,     // 报表最近修改时间
            "status":1,                     // 报表状态 0：未发布 1：已发布 2: 已修改未发布 3: 已下线
            "directory":{                   // 报表资源所属目录结构。如果报表属于根目录，则无该字段。 
                                    "id":"31a87ad2-***",      // 所属目录ID
                  "name":"二级目录",         // 所属目录名称
                  "pathId":"38b2796c-***/31a87ad2-***",   // 目录ID的层级结构，以『/』分隔
                                    "pathName":"一级目录名称/二级目录名称"       // 目录名称的层级结构，以『/』分隔
                                }
        }
    ],
    "success": true
}

说明

由于历史原因，从独立部署3.7版本开始支持FULLPAGE类型。
独立部署3.6，更新或新增auth3rdFlag参数。
独立部署3.7，更新或新增status参数。
独立部署3.8.4，更新或新增directory、workspaceName参数。

JAVA SDK 示例：

public static void getReadableResourcesListByUserId() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/works/readable/user/{userId}/list")
        .setMethod(HttpMethod.GET);
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

查询数据作品的血缘信息

接口路径：/openapi/v2/works/bloodRelationship （GET）
接口描述：获取数据作品的血缘关系，包括各组件引用的数据集以及查询字段信息。目前仅支持的数据作品包含仪表板、数据大屏、即席分析、电子表格、自助取数
起始版本：独立部署3.8.4
输入参数：
参数
类型
描述
是否必需
worksId
string
报表ID
是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object []	返回报表血缘信息。
componentId	string	组件ID。示例值：0696083a-ca72-4d89-8e7a-c017910e0***
componentName	string	组件名称。示例值：线图
componentType	int	组件类型。示例值：3
componentTypeName	string	组件类型名称。示例值：LINE
componentTypeCnName	string	组件类型中文名称。示例值：交叉表
datasetId	string	数据集ID。示例值：dc78a4ed-880d-**-b017-90cfc10c**_company_sales_record
queryParams	object []	查询参数引用列的列表。
uid	string	字段唯一ID。示例值：Ndc78a4_order_number
caption	string	字段原名。示例值：order_number
pathId	string	全局唯一的PathId。示例值：schema7d1944eb-443e-**-8123-bf45a99e7e74.dc78a4ed-880d-452e-b017-90cfc10c**_company_sales_record.[Ndc78a4_order_level].[Ndc78a4_order_level].[Ndc78a4_order_level]
dataType	string	字段类型。取值范围： string：字符串类型 date：仅包含年月日部分的日期类型 datetime：通用日期类型 time：仅包含时分秒部分的日期类型 number：数值类型 boolean：布尔类型 geographic：地理位置 url：字符串类型 imageUrl：图片链接类型 multivalue：多值列示例值：number
isMeasure	boolean	是否是度量。取值范围： true：是 false：否示例值：true
areaId	string	字段所处组件的位置ID。 drill: 下钻 area_value：值轴/度量 area_measure：节点高度/度量 area_dim：节点类别/维度 area_type：类别轴/维度 area_color：颜色图例/维度 area_row：行 area_column：列 filters：过滤器 ..... 示例值：area_column
areaName	string	所属位置名称。示例值：列（度量）
expression	string	计算字段表达式。

返回参数：

{
    "traceId":"9bbd2088-***",
    "code":null,
    "message":null,
    "data":[
        {
            "componentId":"1384fc0e-*",   // 仪表板组件ID或者电子表格sheetId
            "componentName":"线图",        // 组件名称，仪表板才有
            "componentType":3,            // 组件类型，仪表板才有
            "componentTypeName":"LINE",   // 组件类型名称，仪表板才有
            "datasetId":"9392f3dd-*",     // 组件引用的数据集ID
            "queryParams":[               // 查询参数列表
                {
                    "uid":"N9392f3_****_point",    // 数据集中字段的ID
                    "pathId":"4ceed6c3-*.9392f3dd-*.[N9392f3_****_point]",   // 数据集字段ID的全路径
                    "caption":"back_point",        // 字段原名
                    "isMeasure":true,              // 字段是否是度量，true：度量 false：维度
                    "dataType":"number",           // 数据字段类型，string/number/datetime
                    "areaId":"area_value",         // * 字段所处组件的位置。    
                                                   // * drill: 下钻
                                                   // * area_value：值轴/度量
                                                   // * area_measure：节点高度/度量
                                                   // * area_dim：节点类别/维度
                                                   // * area_type：类别轴/维度
                                                   // * area_color：颜色图例/维度
                                                   // * area_row：行
                                                   // * area_column：列
                                                   // * filters：过滤器
                                                   // * .....
                    "areaName":"值轴/度量",          // * areaId的名称解释
                }
            ]
        }
    ],
    "success":true
}

Java SDK 示例：

public static void queryWorksBloodRelationship() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/works/bloodRelationship")
        .setMethod(HttpMethod.GET);
    request.addParameter("worksId","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

查询用户对数据作品的查看权限

接口路径：/openapi/v2/works/readable （GET）
接口描述：查询用户对某一个作品是否有权查看。
输入参数：/openapi/v2/works/readable?worksId=xxx&userId=xxx
参数
类型
描述
是否必需
userId
string
路径参数，需要查询的用户。
是
worksId
string
路径参数，待查询的作品。
是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	boolean	返回接口执行结果。取值范围： true：有权限查看 false：无权限查看

返回参数：

{
  "traceId": "df7a035f-fd1c-****-a32d-51c8db0c5b95",
  "code": null,
  "message": null,
  "data": true,
  "success": true
}

JAVA SDK 示例：

public static void readable() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/works/readable")
        .setMethod(HttpMethod.GET);
    request.addParameter("worksId","xxx");
    request.addParameter("userId","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

获取组织嵌入配置

接口路径：/openapi/v2/works/embed/orgEmbedDetail （GET）
接口描述：获取组织下报表嵌入的相关信息，包含最大嵌入数、已嵌入数。
起始版本：独立部署3.8
输入参数：无

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object	返回报表嵌入信息。
maxCount	int	最大可嵌入数目。
embeddedCount	int	已嵌入数目。
detail	object	各种类型报表的嵌入详情。
page	int	仪表板开通的嵌入数量。
report	int	电子表格开通的嵌入数量。
dashboardOfflineQuery	int	自助取数开通的嵌入数量。

返回参数：

{
    "traceId":"df7a035f-fd1c-****-a32d-51c8db0c5b95",
    "code":null,
    "message":null,
    "data":{
        "maxCount":100,      // 最大可嵌入数
        "embeddedCount":99,  // 当前已经嵌入数
        "detail":{           // 当前已嵌入详情
            "page":81,       // 嵌入的仪表板数量
            "report":7,      // 嵌入的电子表格数量
            "dashboardOfflineQuery":11     // 嵌入的自助取数数量
        }
    },
    "success":true
}

JAVA SDK 示例：

public static void queryEmbeddedInfo() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/works/embed/orgEmbedDetail")
        .setMethod(HttpMethod.GET);
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

查询报表是否已开通嵌入

接口路径：/openapi/v2/works/embed/isEmbedded （GET）
接口描述：查询某个报表是否已经开通嵌入。
起始版本：独立部署3.8
输入参数：
参数
类型
描述
是否必需
worksId
string
查询的报表作品。
是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	boolean	返回接口执行结果。取值范围： true：已经开通嵌入 false：无权限查看

返回参数：

{
  "traceId": "df7a035f-fd1c-****-a32d-51c8db0c5b95",
  "code": null,
  "message": null,
  "data": true,   // true， 已经开通嵌入  false：还未开通嵌入
  "success": true
}

JAVA SDK 示例：

public static void isEmbedded() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/works/embed/isEmbedded")
        .setMethod(HttpMethod.GET);
    request.addParameter("worksId","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

更改报表的嵌入状态

接口路径：/openapi/v2/works/embed/update （PUT）
接口描述：查更改报表的嵌入状态，用于开通嵌入，或者关闭嵌入。
起始版本：独立部署3.8
输入参数：PUT方法的Body参数：
参数
类型
描述
是否必需
worksId
string
修改的报表ID。
是
auth3rdFlag
boolean
true: 开通
false：关闭嵌入
是
参考 JSON 格式如下：
```
{
    "worksId":"abcdxxx",
    "auth3rdFlag":true
}
```

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	int	返回正确修改嵌入状态的报表个数。

返回参数：

{
  "traceId": "df7a035f-fd1c-****-a32d-51c8db0c5b95",
  "code": null,
  "message": null,
  "data": 1,   // 正确修改嵌入状态的报表个数
  "success": true
}

JAVA SDK 示例：

public static void updateEmbeddedStatus() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/works/embed/update")
        .setMethod(HttpMethod.PUT);
    request.addParameter("worksId","xxx");
    request.addParameter("auth3rdFlag","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

根据数据集ID，查询建立在数据集之上的所有报表列表

接口路径：/openapi/v2/works/queryUserWorksByCubeList（GET）
接口描述：根据数据集ID，查询建立在该数据集之上的所有报表的列表，包括仪表板，电子表格，自助取数。
说明
当前接口已过时，请使用新接口查询引用指定数据源下的数据集信息。
起始版本：起始版本：独立部署v4.0 （2021-06）

输入参数：

参数名称	类型	是否必填	描述
cubeList	JSONArray字符串	是	数据集ID列表。格式：数组字符串
userId	String	否	指定报表所属owner ，为userId
worksType	String	否	指定报表类型： PAGE：仪表板 REPORT：旧版电子表格 dashboardOfflineQuery：自助取数

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object []	返回当前数据集列表下该用户创建的报表列表。
previewUrl	string	报表预览链接。
editUrl	string	报表编辑链接。
cubeList	string [ ]	报表依赖的数据集ID列表。
gmtModify	string	报表编辑的时间戳。
modifyName	string	报表编辑者。
status	integer	报表发布状态。取值范围： 0：未发布 1：已发布 2：已修改未发布 3：已下线
workType	string	作品类型。取值范围： PAGE：仪表板 DASHBOARD：仪表板 REPORT：电子表格 dashboardOfflineQuery：自助取数
workName	string	报表名称。
gmtCreate	string	报表创建的时间戳。
ownerName	string	报表所有者的名称。
ownerId	string	报表所有者的UserId。
workspaceName	string	工作空间名称。
workspaceId	string	工作空间ID。
worksId	string	报表的ID。

返回参数：

{
  "traceId":"235c9fa8-d6f5-****-a6d4-38f07b2319ce",
  "code":"0",
  "message":"f441dad7-6878-****-9ad1-84ff92c7d971",
  "success":true,
  "data":[
    {
      "workspaceId":"xxx",
      "workspaceName":"xxx",
      "worksId":"xx",
      "workName":"xxx",
      "workType":"dashboardOfflineQuery",
      "ownerId":"xxx",
      "status": 1,
      "gmtModify":1626683514000,
      "gmtCreate":1626683514000,
      "cubeList":[
            "79c7f420-f3e1-****-93c2-c3ec56be9463"
        ]
    }
  ]
}

JAVA SDK 示例：

 public static void  testQueryAllWorksBaseedCubeID() throws Exception {
        String uri = "/openapi/v2/works/queryUserWorksByCubeList";
        HttpRequest request = HttpRequest.build()
            .setUri(uri)
            .setMethod(HttpMethod.GET);
        request.addParameter("cubeList", new String[] {"eb827efc-f4de-4651-8fc7-2b1362ad9e77"});
        request.addParameter("userId", "123"); // 非必填
        request.addParameter("worksType", "PAGE"); // 非必填
        String result = client.syncExecute(request);
        System.out.println(result);
    }

查询数据作品信息

接口路径：/openapi/v2/works/query（GET）
接口描述：获取数据作品的详情信息，包括数据作品的Owner、创建时间、修改时间等。
起始版本：独立部署4.2
接口参数：
参数
类型
描述
是否必需
worksId
String
报表ID。
是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object	返回报表详情信息
status	int	报表的发布状态。独立部署3.8新增，取值范围： 0：未发布 1：已发布 2：已修改未发布 3：已下线示例值：1
auth3rdFlag	int	第三方嵌入状态。独立部署3.6新增，取值范围： 0：未开通嵌入 1：已开通嵌入示例值：0
worksId	string	报表ID。示例值：97f7f4c1-543a-4069-8e8d-a56cfcd6****
createTime	string	创建时间的毫秒级时间戳。示例值：1530078690000
workType	string	作品类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表 REPORT：电子表格 dashboardOfflineQuery：自助取数示例值：DATAFORM
ownerName	string	作品所有者的账号名。示例值：w****@aliyun.com
accountName	string	作品所有者的账号名。示例值：w****@aliyun.com
workspaceName	string	报表所在工作空间的名称（独立部署3.8.4新增）。示例值：专业版回归
ownerId	string	作品所有者在Quickbi 的UserID。示例值：74f5527216d14e9892245320ebf2****
modifyName	string	修改者的账号名。示例值：13855265****@163.com
workspaceId	string	报表所在工作空间的ID。示例值：c5f86ad2-ef53-4c51-8720-162ecfdb****
securityLevel	string	作品协同授权的安全策略。取值： 0：私密 12：授权指定成员 1或11：授权所有空间成员说明若您使用旧版权限，则返回值为1。若您使用新版权限，则返回值为11。示例值：0
description	string	作品备注。示例值：测试报表的描述
workName	string	报表名称。示例值：测试报表
modifyTime	string	修改时间的毫秒级时间戳。示例值：1530078690000
draftViewUrl	string	仪表板草稿态的预览链接注意： 1、仅对仪表板生效； 2、当组织开启报表的编辑态「允许复制预览链接」功能时，才会返回该项参数值。
directory	object	作品所在的目录信息（独立部署3.8.4新增）。作品位于根目录时不返回
pathId	string	资源所在目录的路径ID。示例值：66ffe22b-83be-47fd-b49d-9ca58d29**/f7f6e22b-83be-47fd-b49d-9ca686a9**
pathName	string	资源所在目录的路径名称。示例值：一级目录/二级目录
name	string	资源名称。示例值：图表报表
id	string	资源所在的目录ID。示例值：f7f6e22b-83be-47fd-b49d-9ca686a9****
publicFlag	boolean	是否公开
publicInvalidTime	integer	报表公开的截止日期
formFillingStatus	boolean	该电子表格中是否配置了表格填报。起始版本：独立部署v5.4.1

返回参数：

{
    "gmtModify": 1595575199000,
    "workName": "测试报表",
    "ownerId": "13651***",
    "accountName": null,
    "gmtCreate": 1595575199000,
    "directory": {
        "pathName": "专属测试",
        "name": "专属测试",
        "id": "ff48e996-d14e-****-ba4c-3af73a9fa396",
        "pathId": "ff48e996-d14e-****-ba4c-3af73a9fa396"
    },
    "securityLevel": "null",
    "auth3rdFlag": 0,
    "ownerName": "luyao账号",
    "worksId": "7d236d2c-***",
    "workType": "PAGE_DIRECTORY",
    "workspaceName": "测试空间",
    "workspaceId": "c7d4b04b-6133-****-a4d4-598ee038892c",
    "status": 1
     "publicFlag": true,
    "publicInvalidTime": 1721366354000,
    "formFillingStatus": true
}

JAVA SDK 示例：

    public static void queryWorks(String worksId) throws SDKException {
        HttpRequest request = HttpRequest.build()
                .setUri("/openapi/v2/works/query")
                .setMethod(HttpMethod.GET);
        request.addParameter("worksId", worksId);
        String result = client.syncExecute(request);
        System.out.println(result);
    }

查询用户有权查看的作品列表

接口路径：/openapi/v2/works/authorize/user/{userId:.+}/list（GET）
接口描述：查询用户有权查看的作品列表，包含空间下、分享授权以及菜单授权的报表。
起始版本：独立部署4.2.2

接口参数：

参数	类型	描述	是否必需
userId	String	路径参数，需要查询的用户。	是
workspaceId	String	工作空间ID	否
workType	String	作品类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表 REPORT：电子表格 dashboardOfflineQuery：自助取数 SCREEN：数据大屏 DATAFORM：数据填报 FULLPAGE：全屏仪表板 ANALYSIS：即席分析示例值：DATAFORM	否

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object []	返回用户所属的所有用户组。
status	int	报表的发布状态。独立部署3.8新增，取值范围： 0：未发布 1：已发布 2：已修改未发布 3：已下线示例值：1
auth3rdFlag	int	第三方嵌入状态。独立部署3.6新增，取值范围： 0：未开通嵌入 1：已开通嵌入示例值：0
worksId	string	报表ID。示例值：97f7f4c1-543a-4069-8e8d-a56cfcd6****
createTime	string	创建时间的毫秒级时间戳。示例值：1530078690000
workType	string	作品类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表 REPORT：电子表格 dashboardOfflineQuery：自助取数示例值：DATAFORM
ownerName	string	作品所有者的账号名。示例值：w****@aliyun.com
accountName	string	作品所有者的账号名。示例值：w****@aliyun.com
workspaceName	string	报表所在工作空间的名称（独立部署3.8.4新增）。示例值：专业版回归
ownerId	string	作品所有者在Quickbi 的UserID。示例值：74f5527216d14e9892245320ebf2****
modifyName	string	修改者的账号名。示例值：13855265****@163.com
workspaceId	string	报表所在工作空间的ID。示例值：c5f86ad2-ef53-4c51-8720-162ecfdb****
securityLevel	string	作品协同授权的安全策略。取值： 0：私密 12：授权指定成员 1或11：授权所有空间成员说明若您使用旧版权限，则返回值为1。若您使用新版权限，则返回值为11。示例值：0
description	string	作品备注。示例值：测试报表的描述
workName	string	报表名称。示例值：测试报表
modifyTime	string	修改时间的毫秒级时间戳。示例值：1530078690000
draftViewUrl	string	仪表板草稿态的预览链接注意： 1、仅对仪表板生效； 2、当组织开启报表的编辑态「允许复制预览链接」功能时，才会返回该项参数值。
directory	object	作品所在的目录信息（独立部署3.8.4新增）。作品位于根目录时不返回
pathId	string	资源所在目录的路径ID。示例值：66ffe22b-83be-47fd-b49d-9ca58d29**/f7f6e22b-83be-47fd-b49d-9ca686a9**
pathName	string	资源所在目录的路径名称。示例值：一级目录/二级目录
name	string	资源名称。示例值：图表报表
id	string	资源所在的目录ID。示例值：f7f6e22b-83be-47fd-b49d-9ca686a9****
formFillingStatus	boolean	该电子表格中是否配置了表格填报。起始版本：独立部署v5.4.1

返回参数：

{
    "traceId": "284d25a9-34f0-****-8f76-98b1aeba766d",
    "code": null,
    "message": null,
    "data": [
        {
            "worksId": "f3bf46a8-****", 
            "workType": "PAGE",
            "workName": "报表名称",
            "workspaceId": "87c6b145-****",
            "workspaceName": "xxxxx",
            "securityLevel": "0",
            "auth3rdFlag":0,
            "description": null, 
            "ownerId": "363e88800032",
            "accountName": null,
            "ownerName": "xxxxpaw@aliyun.com",
            "modifyName": null,
            "gmtCreate": 1484818350000,
            "gmtModify": 1557823287000,
            "status":1,
            "directory":{ 
            		"id":"31a87ad2-***",
                    "name":"二级目录",
                    "pathId":"38b2796c-***/31a87ad2-***",
            		"pathName":"一级目录名称/二级目录名称"
       		},
       	    "formFillingStatus": false
        }
    ],
    "success": true
}

Java SDK 示例：

private static void queryAuthorizeWorksByUserId(String userId) throws Exception {
    HttpRequest request = HttpRequest.build()
        .setUri("/authorize/user/"+userId+"/list")
        .setMethod(HttpMethod.GET);
    String result = client.syncExecute(request);
    System.out.println(result);
}

获取用户的自助取数记录

接口路径：/openapi/v2/works/offlineDownload/getList（GET）
接口描述：获取用户最近一段时间内成功的自助取数记录。
起始版本：独立部署4.3
接口参数：
参数
类型
描述
是否必需
userId
String
用户ID。
是
startTime
String
查询的起始时间。
格式为2022-02-16 09:18:16
是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object [ ]	返回自助取数记录列表。
downloadId	string	自足取数任务ID。
downloadName	string	用户指定下载到本地的文件名。
creatorId	string	任务创建人ID。
creatorName	string	任务创建人名称。
pageId	string	取数对应的仪表板或者自助取数报表的ID。
status	integer	任务是否成功，该接口返回都是1。
message	string	取数任务的执行回执。
costTime	integer	取数任务耗时,单位秒。
fileId	string	取数文件ID。
fileUrl	string	文件路径。
gmtCreate	string	取数任务创建时间。
isDeleted	boolean	任务文件是否被删除。

返回参数：

{
    "traceId": "b442c4c5-0f97-****-b397-0cf98b2febcd",
    "code": "0",
    "message": "success",
    "data": [
        {
            "downloadId": "2bea9a58-4dbb-****-a0c6-bf88931873af",  // 取数任务ID
            "downloadName": "independentdemo2_自助取数", // 用户指定下载到本地的文件名
            "creatorId": "fec074144320*****b1905061e6a951a2", // 任务创建人ID
            "creatorName": "quickBiAdmin", // 任务创建人昵称
            "pageId": "1a824718-3a82-4b01-a1eb-8a09d47769d8", // 取数对应的仪表板或者自助取数报表的id
            "status": 1, // 任务是否成功， 该接口返回都是 1。
            "message": "success", // 取数任务的执行回执
            "costTime": 0, // 取数任务耗时，单位秒
            "fileId": "8b232f2****c4591a66247ba7174f7b0", // 取数任务生成的文件ID
            "fileUrl": // 文件路径
            "gmtCreate": "2022-04-19 10:27:55", // 取数任务创建时间
            "deleted": false, // 任务文件是否被删除
        }
    ],
    "success": true,
    "httpCode": 200,
    "dynamicMessage": null
}

JAVA SDK 示例：

public static void listOfflineDownloadRecord() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/works/offlineDownload/getList")
        .setMethod(HttpMethod.GET);
    request.addParameter("userId","xxx");
    request.addParameter("startTime","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

查询组件性能日志

接口路径：/openapi/v2/auditlog/analysis/component/queryPerformance（GET）
接口描述：查询组件性能列表
版本起始：起始版本：独立部署ind_5.2

接口参数：

参数名称	类型	参数描述	是否必需
queryType	String	查询类型	是
workspaceId	String	工作空间id	是
reportId	String	报表id	否
resourceType	String	报表类型	否
costTimeAvgMin	String	平均查询耗时最小值	否
pageSize	Integer	页数	是
pageNum	Integer	页面大小	是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object [ ]	返回自助取数记录列表。
componentId	string	组件id
componentName	string	组件名称
reportId	string	所属仪表板ID
reportType	string	报表类型
reportName	string	所属仪表板名称
queryTimeoutCount	Integer	图表查询超时次数。
RepeatSqlQueryPercent	string	重复查询占比
workspaceName	string	空间名称
workspaceId	string	空间唯一 ID
repeatQueryPercentNum	Integer	重复查询数量
repeatQueryPercent	string	重复查询占比
quickIndexCostTimeAvg	double	命中 Quick 引擎平均查询耗时
quickIndexQueryCount	Integer	命中 Quick 引擎次数
cacheCostTimeAvg	double	命中缓存平均耗时
cacheQueryCount	Integer	命中缓存次数
repeatSqlQueryCount	Integer	重复查询次数
costTimeAvg	double	平均查询时间
queryCountAvg	double	平均查询次数
queryCount	Integer	查询次数
queryTimeoutCountPercent	double	图表查询超时次数占比
queryOverTenSecPercentNum	double	查询超过 10s 查询次数占比
queryOverFivePercentNum	double	查询超过 5s 查询次数
queryOverTenSecPercent	string	查询超过 10s 占比
queryOverFiveSecPercent	string	查询超过 5s 占比

返回参数：

{
    "traceId": "b442c4c5-0f97-****-b397-0cf98b2febcd",
    "code": "0",
    "message": "success",
    "data": [
    {
      "ComponentId": "0696083a-ca72-****-8e7a-c017910e0***",
      "ComponentName": "线图",
      "ReportId": "6b407e50-e774-****-9956-da2425c2****",
      "ReportName": "ClusterRiskReport",
      "ReportType": "report",
      "QueryTimeoutCount": 1,
      "RepeatSqlQueryPercent": "0.3",
      "WorkspaceName": "测试空间",
      "WorkspaceId": "89713491-cb4f-****-b889-e82c35f1****",
      "RepeatQueryPercentNum": 2,
      "RepeatQueryPercent": "0.3",
      "QuickIndexCostTimeAvg": 0.3,
      "QuickIndexQueryCount": 3,
      "CacheCostTimeAvg": 0.3,
      "CacheQueryCount": 3,
      "RepeatSqlQueryCount": 5,
      "CostTimeAvg": 0.3,
      "QueryCountAvg": 0.3,
      "QueryCount": 5,
      "QueryTimeoutCountPercent": 0.3,
      "QueryOverTenSecPercentNum": 0.3,
      "QueryOverFivePercentNum": 5,
      "QueryOverTenSecPercent": "0.3",
      "QueryOverFiveSecPercent": "0.3"
    }
  ],
    "success": true,
    "httpCode": 200,
    "dynamicMessage": null
}

JAVA SDK 示例：

public static void queryPerformance() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/auditlog/analysis/component/queryPerformance")
        .setMethod(HttpMethod.GET);
    request.addParameter("queryType","xxx");
    request.addParameter("workspaceId","xxx");
    request.addParameter("reportId","xxx");
    request.addParameter("resourceType","xxx");
    request.addParameter("costTimeAvgMin","xxx");
    request.addParameter("pageSize","10");
    request.addParameter("pageNum","1");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

查询报表性能日志

接口路径：/openapi/v2/auditlog/analysis/report/queryPerformance（GET）
接口描述：查询报表性能列表
版本起始：起始版本：独立部署ind_5.2

接口参数：

参数名称	类型	参数描述	是否必需
queryType	String	查询类型	是
workspaceId	String	工作空间id	是
reportId	String	报表id	否
resourceType	String	报表类型	否
costTimeAvgMin	String	平均查询耗时最小值	否
pageSize	Integer	页数	是
pageNum	Integer	页面大小	是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object [ ]	返回自助取数记录列表。
reportId	string	报表id
reportType	string	报表类型
reportName	string	报表名称
componentQueryCount	integer	图表查询次数
componentQueryCountAvg	double	图表平均查询次数
queryTimeoutCount	integer	图表查询超时次数
repeatSqlQueryPercent	string	重复查询占比
workspaceName	string	空间名称
workspaceId	string	作品所属工作空间 ID
repeatQueryPercentNum	double	重复查询数量
repeatQueryPercent	string	重复查询占比
quickIndexCostTimeAvg	double	命中 Quick 引擎平均查询耗时
quickIndexQueryCount	integer	命中 Quick 引擎次数
cacheCostTimeAvg	double	命中缓存平均耗时
cacheQueryCount	integer	命中缓存次数
repeatSqlQueryCount	integer	重复查询次数
queryCountAvg	double	平均查询次数
queryCount	integer	查询次数
queryTimeoutCountPercent	double	图表查询超时次数占比
queryOverTenSecPercentNum	double	查询超过 5s 查询次数占比
queryOverTenSecPercent	string	查询超过 10s 占比
queryOverFiveSecPercent	string	查询超过 5s 占比

返回参数：

{
    "traceId": "b442c4c5-0f97-****-b397-0cf98b2febcd",
    "code": "0",
    "message": "success",
    "data": [
    {
      "ComponentId": "0696083a-ca72-****-8e7a-c017910e0***",
      "ComponentName": "线图",
      "ReportId": "6b407e50-e774-****-9956-da2425c2****",
      "ReportName": "ClusterRiskReport",
      "ReportType": "report",
      "QueryTimeoutCount": 1,
      "RepeatSqlQueryPercent": "0.3",
      "WorkspaceName": "测试空间",
      "WorkspaceId": "89713491-cb4f-****-b889-e82c35f1****",
      "RepeatQueryPercentNum": 2,
      "RepeatQueryPercent": "0.3",
      "QuickIndexCostTimeAvg": 0.3,
      "QuickIndexQueryCount": 3,
      "CacheCostTimeAvg": 0.3,
      "CacheQueryCount": 3,
      "RepeatSqlQueryCount": 5,
      "CostTimeAvg": 0.3,
      "QueryCountAvg": 0.3,
      "QueryCount": 5,
      "QueryTimeoutCountPercent": 0.3,
      "QueryOverTenSecPercentNum": 0.3,
      "QueryOverFivePercentNum": 5,
      "QueryOverTenSecPercent": "0.3",
      "QueryOverFiveSecPercent": "0.3"
    }
  ],
    "success": true,
    "httpCode": 200,
    "dynamicMessage": null
}

JAVA SDK 示例：

public static void queryReportPerformance() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/auditlog/analysis/report/queryPerformance")
        .setMethod(HttpMethod.GET);
    request.addParameter("queryType","xxx");
    request.addParameter("workspaceId","xxx");
    request.addParameter("reportId","xxx");
    request.addParameter("resourceType","xxx");
    request.addParameter("costTimeAvgMin","xxx");
    request.addParameter("pageSize","10");
    request.addParameter("pageNum","1");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

获取已经嵌入报表列表

接口：/openapi/v2/works/embed/getWorksEmbedList (POST)
描述：获取（相同组织内）嵌入分析列表。
起始版本：独立部署v5.2.2

输入参数：（content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交）

参数	类型	描述	是否必需
pageSize	Integer	每页显示的条数（为空默认选10）	否
pageNo	Integer	页数（为空默认选1）	否
keyword	String	报表名称（模糊匹配）	否
worksType	String	报表类型（不传为查询所有，查询特定类型需传以下对应的枚举） `dataProduct, 数据门户 page, 仪表板 screen, 数据大屏 report", 电子表格 ANALYSIS, 即席分析 dashboardOfflineQuery, 自助取数 dataForm, 数据填报`	否
wsId	String	工作空间id	否

说明

注意：SDK调用时，如果水印参数或全局参数中带上了中文符号，必须进URLEncoder.encode(keyword, "UTF-8")后进行传参，encode前的参数形式如下：

keyword = "测试";

URLEncoder.encode(keyword, "UTF-8")

如果包含空格，需要在URLEncoder之前转为%20，例如：

keyword = "测试%20";

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
totalNum	Integer	总条数
totalPages	Integer	总页码
pageSize	Integer	每页显示的条数
pageNo	Integer	页数
data	object	返回信息
list	list[]	报表信息数组
embedTime	string	嵌入时间
worksId	string	报表ID
worksName	string	报表名称
worksType	string	报表类型
workspaceId	string	所属空间ID
totalNum	int	总条数
totalPages	int	总页码
pageSize	int	每页显示的条数
pageNo	int	页数

返回参数示例：

{
    "traceId": "235c9fa8-d6f5-****-a6d4-38f07b2319ce",
    "code": "0",
    "message": "f441dad7-6878-****-9ad1-84ff92c7d971",
    "success": true,
    "data": {
        "data": [
            {
                "embedTime": "2017-07-31 17:05:35",
                "worksId": "1f75f13b-b90b-****-bfbe-92fb079f84aa",
                "worksName": "admin_page_2",
                "worksType": "PAGE",
                "workspaceId": "6896ecc7-a62a-****-b40b-ff2d53c2218c"
            },
            {
                "embedTime": "2017-07-31 17:04:53",
                "worksId": "046031ec-3bb7-****-810e-b6cb9933ffc8",
                "worksName": "develop_page_1_new",
                "worksType": "PAGE",
                "workspaceId": "6896ecc7-a62a-****-b40b-ff2d53c2218c"
            },
            {
                "embedTime": "2017-07-31 17:03:50",
                "worksId": "b882d42d-ce04-****-b51b-13bbbf160365",
                "worksName": "analyse_page_1_new",
                "worksType": "PAGE",
                "workspaceId": "6896ecc7-a62a-****-b40b-ff2d53c2218c"
            }
        ],
        "totalNum": 3,
        "totalPages": 1,
        "pageSize": 10,
        "pageNo": 1
    }
}

JAVA SDK 示例：

    /**
     * 获取嵌入列表
     */
    @Test
    public void getWorksEmbedList() throws SDKException {
        String url = "/openapi/v2/works/embed/getWorksEmbedList";
        HttpRequest request = HttpRequest.build()
                .setUri(url)
                .setMethod(HttpMethod.POST).setHttpContentType(FormatType.FORM);

        request.addParameter("pageSize", "100");
        request.addParameter("pageNo", "1");
//     request.addParameter("worksType", "PAGE");
//        request.addParameter("keyword", "page");
//        request.addParameter("wsId", "6896ecc7-a62a-4e8a-b40b-ff2d53c2218c");
//        request.addParameter("worksType", "PAGE");

        String result = getOpenApiClient("daliy").syncExecute(request);
        System.out.println(result);
    }

获取用户的导出记录

接口：/openapi/v2/works/exportRecords (GET)
描述：获取用户的导出记录，一次最多返回10000条。
起始版本：独立部署v5.4.1

输入参数：

参数	类型	描述	是否必需
userId	string	操作用户ID，不传就看整个组织的。	否
startTime	string	查询的起始时间，格式为2022-06-16 09:18:04。	否
endTime	string	查询的结束时间，格式为2022-06-16 09:18:04。	否

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object[]	返回标签元信息列表。一次最多返回10000条
downloadType	string	下载类型： download--自助取数 export--导出
workId	string	作品ID。
workName	string	作品名称。
workType	string	作品类型： PAGE--仪表板 dashboardOfflineQuery--自助取数 REPORT--电子表格
workspaceId	string	空间ID。
storePath	string	文件在服务器完整存储路径。（如果创建自助取数数据时没有在导出配置中勾选复用基础配置则为空） sftp 格式为 sftp://host:port/路径 OSS 格式为 oss://bucket/xxxx
createTime	string	创建时间，格式为 yyyy-mm-dd hh:mm:ss。

返回参数示例：

{
    "traceId": "f09d9c36**********dd10a80602",
    "code": "0",
    "message": "success",
    "data": [
            {
            "storePath": "oss://qui*****250310_1003_目标页面.pdf_4943d9db",
            "createTime": "2025-03-10 10:04:00",
            "workType": "PAGE",
            "downloadType": "export",
            "workName": "目标页面",
            "workId": "35cdaaa0-**********a49e4b65d2",
            "workspaceId": "3e60ee7f**************f6d25fcaa886"
        }
    ],
    "success": true
}

JAVA SDK 示例：

 @Test
public void queryUserExportRecords() throws SDKException {
    String url = "/openapi/v2/works/exportRecords";
    HttpRequest request2 = HttpRequest.build()
            .setUri(url)
            .setMethod(HttpMethod.GET);
    request2.addParameter("userId", "fec0741443204104b1905061e6a951a2");
    request2.addParameter("startTime", "2025-03-01 08:00:00");
    request2.addParameter("endTime", "2025-03-10 08:00:00");
    String result = getOpenApiClient("test").syncExecute(request2);
    System.out.println(result);
}