文档

QueryWorks - 查询数据作品信息

更新时间:

查询指定数据作品信息。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
WorksIdstring

报表 ID

abcd****

返回参数

名称类型描述示例值
object
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

作品详情信息。

WorksIdstring

作品 ID。

95296e95-ca89-4c7d-8af9-dedf0ad0****
WorkTypestring

查询作品的类型,填空为查询所有类型。取值范围:

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • FULLPAGE:全屏仪表板
  • REPORT:电子表格
  • dashboardOfflineQuery:自助取数
PAGE
WorkNamestring

作品名称。

测试报表
WorkspaceIdstring

作品所属工作空间的 ID。

87c6b145-090c-43e1-9426-8f93be23****
WorkspaceNamestring

作品所属工作空间名称。

测试空间
Directoryobject

作品所属目录。

Idstring

所属目录 ID。

83d37ba6-d909-48a2-a517-f4d05c3a****
Namestring

目录名称。

测试目录
PathIdstring

所属目录 ID 的层级结构,以『/』分隔。

83d37ba6-d909-48a2-a517-f4d05c3a****
PathNamestring

所属目录名称的层级结构,以『/』分隔。

测试目录
SecurityLevelstring

作品协同授权的安全策略。取值:

  • 0:私密
  • 12:授权指定成员
  • 1 或 11:授权所有空间成员
说明
  • 若您使用旧版权限,则返回值为 1。
  • 若您使用新版权限,则返回值为 11。
  • 0
    Auth3rdFlaginteger

    第三方嵌入状态。取值范围:

    • 0:暂未开通嵌入
    • 1:已开通嵌入
    0
    Descriptionstring

    作品备注。

    备注
    OwnerIdstring

    作品所有者在 Quick BI 的 UserID。

    9187a612aa474e2a8ac1414d5529****
    OwnerNamestring

    作品所有者的阿里云账户名。

    张三
    ModifyNamestring

    作品修改者的阿里云账户名。

    张三
    GmtCreatestring

    作品创建的毫秒级时间戳。

    1496651577000
    GmtModifystring

    作品修改的毫秒级时间戳。

    1496651577000
    Statusinteger

    报表状态。取值范围:

    • 0:未发布
    • 1:已发布
    • 2:已修改未发布
    • 3:已下线
    0
    PublicFlagboolean

    是否公开

    true
    PublicInvalidTimelong

    报表公开的截止日期

    1721366354000

    示例

    正常返回示例

    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,
        "PublicFlag": true,
        "PublicInvalidTime": 1721366354000
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    400Invalid.Works.EmptyThis work does not exist. It may have been deleted. Work ID is %s.作品不存在,可能已经被删除。作品ID:%s。
    400Internal.System.ErrorAn internal system error occurred.系统内部异常。
    400Resource.NotBelongTo.CurrentOrganizationThe resource does not belong to the current organization.该资源不属于当前组织。
    400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
    400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
    400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
    400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
    400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
    400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
    400Invalid.Param.ErrorThe parameter is invalid.无效参数。
    400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
    400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
    400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
    400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
    400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
    400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
    400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
    400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

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

    变更历史

    变更时间变更内容概要操作
    2024-06-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更