调用QueryWorksByWorkspace查询工作空间下的所有作品_智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

查询组织下某个工作空间下的所有作品，可指定作品类型。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	是	工作空间 ID。	89713491-cb4f-4579-b889-e82c35f1****
WorksType	string	否	作品类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表板 FULLPAGE：全屏仪表板 REPORT：电子表格	PAGE
Status	integer	否	作品状态。取值范围： 0：未发布 1：已发布 2：已修改未发布 3：已下线	0
ThirdPartAuthFlag	integer	否	第三方嵌入状态。取值范围： 0：暂未开通嵌入 1：已开通嵌入	0
PageNum	integer	否	页码。默认值 1。	1
PageSize	integer	否	每页行数。默认值 10。	10

返回参数

名称	类型	描述	示例值
	object
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true
RequestId	string	请求 ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	返回组织工作空间下所有符合请求条件的作品列表。
TotalPages	integer	总页码。	1
PageNum	integer	页码。	1
PageSize	integer	请求接口时设置的每页行数。	10
TotalNum	integer	总行数。	1
Data	array<object>	作品列表详情。
Data	object
Status	integer	仪表板，全屏仪表板，电子表格的状态。其他作品类型默认为 1，取值范围： 0：未发布 1：已发布 2：已修改未发布 3：已下线	1
GmtModify	string	作品修改的毫秒级时间戳。	1572334870000
Auth3rdFlag	integer	第三方嵌入状态。取值范围： 0：暂未开通嵌入 1：已开通嵌入	1
WorksId	string	作品 ID。	897ce25e-f993-4abd-af84-d13c5610****
WorkType	string	作品类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表板 FULLPAGE：全屏仪表板 REPORT：电子表格 dashboardOfflineQuery：自助取数 ANALYSIS：即席分析 DATAFORM：表单填报	PAGE
OwnerName	string	作品所有者的昵称。	李四
WorkspaceName	string	作品所属工作空间名称。	测试工作空间
OwnerId	string	作品所有者在 Quick BI 的 UserID。	作品所属工作空间名称。
ModifyName	string	作品修改者的昵称。	张三
WorkspaceId	string	作品所属工作空间的 ID。	87c6b145-090c-43e1-9426-8f93be23****
SecurityLevel	string	作品协同授权的安全策略。取值： 0：私密 12：授权指定成员 1 或 11：授权所有空间成员说明若您使用旧版权限，则返回值为 1。若您使用新版权限，则返回值为 11。	0
Description	string	作品备注。	备注
WorkName	string	作品名称。	测试报表
GmtCreate	string	作品创建的毫秒级时间戳。	1496651577000
Directory	object	作品所属目录。
PathId	string	所属目录 ID 的层级结构，以『/』分隔。	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	所属目录名称的层级结构，以『/』分隔。	测试目录
Name	string	所属目录名称。	所属目录名称。
Id	string	所属目录 ID。	83d37ba6-d909-48a2-a517-f4d05c3a****
PublicFlag	boolean	是否公开	true
PublicInvalidTime	long	报表公开的截止日期	1721366354000

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "TotalPages": 1,
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "Data": [
      {
        "Status": 1,
        "GmtModify": "1572334870000",
        "Auth3rdFlag": 1,
        "WorksId": "897ce25e-f993-4abd-af84-d13c5610****",
        "WorkType": "PAGE",
        "OwnerName": "李四",
        "WorkspaceName": "测试工作空间",
        "OwnerId": "作品所属工作空间名称。",
        "ModifyName": "张三",
        "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
        "SecurityLevel": "0",
        "Description": "备注",
        "WorkName": "测试报表",
        "GmtCreate": "1496651577000",
        "Directory": {
          "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "PathName": "测试目录",
          "Name": "所属目录名称。",
          "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****"
        },
        "PublicFlag": true,
        "PublicInvalidTime": 1721366354000
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Internal.System.Error	An internal system error occurred.	系统内部异常。

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

变更历史

变更时间	变更内容概要	操作
2024-06-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情