GetWorksEmbedList - 获取已经嵌入的报表 - 智能商业分析 Quick BI

查询已嵌入报表列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:GetWorksEmbedList

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
WsId	string	否	工作空间 ID	919818-*-***-wdasd
WorksType	string	否	报表类型 page, 仪表板 screen, 数据大屏 report, 电子表格 ANALYSIS, 即席分析 dashboardOfflineQuery, 自助取数 dataForm, 数据填报枚举值： dataForm : 数据填报 dashboardOfflineQuery : 自助取数 report : 电子表格 screen : 数据大屏 ANALYSIS : 即席分析 page : 仪表板	page
Keyword	string	否	报表名称（模糊匹配）	测试数据集
PageNo	integer	否	页数（为空默认选 1）	1
PageSize	integer	否	每页显示的条数（为空默认选 10）	100

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	38C0F***0-4159F1-***422BDB65
Result	object	报表数组对象
Data	array<object>	报表数组
	object	报表对象
EmbedTime	string	嵌入时间	YYYY-mm-DD hh:MM:ss
WorksId	string	报表 ID	897ce25e-**--af84-d13c5610**
WorksName	string	报表名称	测试哦
WorksType	string	报表类型	page
WorkspaceId	string	所属空间 ID	87c6b145-**-43e1-9426-8f93be23**
PageNo	integer	页数	1
PageSize	integer	每页显示的条数	10
TotalNum	integer	总条数	18
TotalPages	integer	总页码	2
Success	boolean	请求是否成功	true

示例

正常返回示例

JSON格式

{
  "RequestId": "38C0F*****0-415****9F1-*****422BDB65",
  "Result": {
    "Data": [
      {
        "EmbedTime": "YYYY-mm-DD hh:MM:ss",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorksName": "测试哦",
        "WorksType": "page",
        "WorkspaceId": "87c6b145-****-43e1-9426-8f93be23****"
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "TotalNum": 18,
    "TotalPages": 2
  },
  "Success": true
}

错误码

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

变更历史

更多信息，参考变更详情。