查询组织下某个工作空间下的所有作品，可指定作品类型。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:QueryWorksByWorkspace |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WorkspaceId |
string |
是 |
工作空间 ID。 |
89713491-cb4f-4579-b889-e82c35f1**** |
| WorksType |
string |
否 |
作品类型。取值范围：
|
PAGE |
| Status |
integer |
否 |
作品状态。取值范围：
|
0 |
| ThirdPartAuthFlag |
integer |
否 |
第三方嵌入状态。取值范围：
|
0 |
| PageNum |
integer |
否 |
页码。
|
1 |
| PageSize |
integer |
否 |
每页行数。
|
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Success |
boolean |
是否请求成功。取值范围：
|
true |
| RequestId |
string |
请求 ID。 |
D787E1A3-A93C-424A-B626-C2B05DF8D885 |
| Result |
object |
返回组织工作空间下所有符合请求条件的作品列表。 |
|
| Data |
array<object> |
作品列表详情。 |
|
|
array<object> |
|||
| Auth3rdFlag |
integer |
第三方嵌入状态。取值范围：
|
1 |
| Description |
string |
作品备注。 |
备注 |
| Directory |
object |
作品所属目录。 |
|
| Id |
string |
所属目录 ID。 |
83d37ba6-d909-48a2-a517-f4d05c3a**** |
| Name |
string |
所属目录名称。 |
所属目录名称。 |
| PathId |
string |
所属目录 ID 的层级结构，以『/』分隔。 |
83d37ba6-d909-48a2-a517-f4d05c3a**** |
| PathName |
string |
所属目录名称的层级结构，以『/』分隔。 |
测试目录 |
| GmtCreate |
string |
作品创建的毫秒级时间戳。 |
1496651577000 |
| GmtModify |
string |
作品修改的毫秒级时间戳。 |
1572334870000 |
| ModifyName |
string |
作品修改者的昵称。 |
张三 |
| OwnerId |
string |
作品所有者在 Quick BI 的 UserID。 |
作品所属工作空间名称。 |
| OwnerName |
string |
作品所有者的昵称。 |
李四 |
| PublicFlag |
boolean |
是否公开 |
true |
| PublicInvalidTime |
integer |
报表公开的截止日期 |
1721366354000 |
| SecurityLevel |
string |
作品协同授权的安全策略。取值：
说明
|
0 |
| Status |
integer |
仪表板，全屏仪表板，电子表格的状态。其他作品类型默认为 1，取值范围：
|
1 |
| WorkName |
string |
作品名称。 |
测试报表 |
| WorkType |
string |
作品类型。取值范围：
|
PAGE |
| WorksId |
string |
作品 ID。 |
897ce25e-f993-4abd-af84-d13c5610**** |
| WorkspaceId |
string |
作品所属工作空间的 ID。 |
87c6b145-090c-43e1-9426-8f93be23**** |
| WorkspaceName |
string |
作品所属工作空间名称。 |
测试工作空间 |
| PageNum |
integer |
页码。 |
1 |
| PageSize |
integer |
请求接口时设置的每页行数。 |
10 |
| TotalNum |
integer |
总行数。 |
1 |
| TotalPages |
integer |
总页码。 |
1 |
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": {
"Data": [
{
"Auth3rdFlag": 1,
"Description": "备注",
"Directory": {
"Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
"Name": "所属目录名称。",
"PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
"PathName": "测试目录"
},
"GmtCreate": "1496651577000",
"GmtModify": "1572334870000",
"ModifyName": "张三",
"OwnerId": "作品所属工作空间名称。",
"OwnerName": "李四",
"PublicFlag": true,
"PublicInvalidTime": 1721366354000,
"SecurityLevel": "0",
"Status": 1,
"WorkName": "测试报表",
"WorkType": "PAGE",
"WorksId": "897ce25e-f993-4abd-af84-d13c5610****",
"WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
"WorkspaceName": "测试工作空间"
}
],
"PageNum": 1,
"PageSize": 10,
"TotalNum": 1,
"TotalPages": 1
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。