查询已嵌入报表列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:GetWorksEmbedList |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WsId |
string |
否 |
工作空间 ID |
919818-***-*****-wdasd |
| WorksType |
string |
否 |
报表类型
枚举值:
|
page |
| Keyword |
string |
否 |
报表名称(模糊匹配) |
测试数据集 |
| PageNo |
integer |
否 |
页数(为空默认选 1) |
1 |
| PageSize |
integer |
否 |
每页显示的条数(为空默认选 10) |
100 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID |
38C0F*****0-415****9F1-*****422BDB65 |
| Result |
object |
报表数组对象 |
|
| Data |
array<object> |
报表数组 |
|
|
object |
报表对象 |
||
| EmbedTime |
string |
嵌入时间,格式为 YYYY-mm-DD hh:MM:ss。 |
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
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。