调用QueryWorks查询数据作品信息_Quick BI-阿里云帮助中心

查询指定数据作品信息。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
WorksId	string	是	报表ID	abcd****

返回参数

名称	类型	描述	示例值
	object
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true
RequestId	string	请求ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	作品详情信息。
WorksId	string	作品ID。	95296e95-ca89-4c7d-8af9-dedf0ad0****
WorkType	string	查询作品的类型，填空为查询所有类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表板 FULLPAGE：全屏仪表板 REPORT：电子表格 dashboardOfflineQuery：自助取数	PAGE
WorkName	string	作品名称。	测试报表
WorkspaceId	string	作品所属工作空间的ID。	87c6b145-090c-43e1-9426-8f93be23****
WorkspaceName	string	作品所属工作空间名称。	测试空间
Directory	object	作品所属目录。
Id	string	所属目录ID。	83d37ba6-d909-48a2-a517-f4d05c3a****
Name	string	目录名称。	测试目录
PathId	string	所属目录ID的层级结构，以『/』分隔。	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	所属目录名称的层级结构，以『/』分隔。	测试目录
SecurityLevel	string	作品协同授权的安全策略。取值： 0：私密 12：授权指定成员 1或11：授权所有空间成员说明若您使用旧版权限，则返回值为1。若您使用新版权限，则返回值为11。	0
Auth3rdFlag	integer	第三方嵌入状态。取值范围： 0：暂未开通嵌入 1：已开通嵌入	0
Description	string	作品备注。	备注
OwnerId	string	作品所有者在Quick BI的UserID。	9187a612aa474e2a8ac1414d5529****
OwnerName	string	作品所有者的阿里云账户名。	张三
ModifyName	string	作品修改者的阿里云账户名。	张三
GmtCreate	string	作品创建的毫秒级时间戳。	1496651577000
GmtModify	string	作品修改的毫秒级时间戳。	1496651577000
Status	integer	报表状态。取值范围： 0：未发布 1：已发布 2：已修改未发布 3：已下线	0

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
    "WorkType": "PAGE",
    "WorkName": "测试报表",
    "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
    "WorkspaceName": "测试空间",
    "Directory": {
      "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "Name": "测试目录",
      "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "PathName": "测试目录"
    },
    "SecurityLevel": "0",
    "Auth3rdFlag": 0,
    "Description": "备注",
    "OwnerId": "9187a612aa474e2a8ac1414d5529****",
    "OwnerName": "张三",
    "ModifyName": "张三",
    "GmtCreate": "1496651577000",
    "GmtModify": "1496651577000",
    "Status": 0
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Invalid.Works.Empty	works not exist!	-
400	Instance.Expired	Your instance has expired.	您的购买实例已经过期。
400	Instance.Not.Exist	The specified instance does not exist.	暂未匹配到您的购买实例。
400	System.Param.Empty	You must specify the %s parameter.	参数%s不能为空。
400	Access.Forbidden	Access forbidden. Your instance version or access key is not allowed to call the API operation.	-
400	Internal.System.Error	An internal system error occurred.	系统内部异常。
400	Resource.NotBelongTo.CurrentOrganization	The resource does not belong to the current organization.	该资源不属于当前组织。
400	Invalid.Organization	The specified organizational unit does not exist.	该组织不存在。
400	User.Not.In.Organization	The specified user is not in the organizational unit.	该用户不在组织中。
400	Invalid.Parameter	An error occurred while verifying parameters.	参数验证失败。
400	Invalid.Parameter.Error	The parameter is invalid:%s.	无效参数%s。
400	Invalid.Param.Error	The parameter is invalid.	无效参数。
400	Invalid.User.Admin	You are not an administrator of this organization.	没有权限，您不是组织管理员。
400	UserInfo.Error	The personal information is invalid.	个人信息不合法。
400	ApiUser.Not.Exists	The specified user does not exist.	用户不存在。

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