文档

QueryWorksByWorkspace - 查询工作空间下的所有作品

更新时间:

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

调试

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

授权信息

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

请求参数

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

工作空间 ID。

89713491-cb4f-4579-b889-e82c35f1****
WorksTypestring

作品类型。取值范围:

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • FULLPAGE:全屏仪表板
  • REPORT:电子表格
PAGE
Statusinteger

作品状态。取值范围:

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

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

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

页码。

  • 默认值 1。
1
PageSizeinteger

每页行数。

  • 默认值 10。
10

返回参数

名称类型描述示例值
object
Successboolean

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

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

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

返回组织工作空间下所有符合请求条件的作品列表。

TotalPagesinteger

总页码。

1
PageNuminteger

页码。

1
PageSizeinteger

请求接口时设置的每页行数。

10
TotalNuminteger

总行数。

1
Dataobject []

作品列表详情。

Statusinteger

仪表板,全屏仪表板,电子表格的状态。其他作品类型默认为 1,取值范围:

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

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

1572334870000
Auth3rdFlaginteger

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

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

作品 ID。

897ce25e-f993-4abd-af84-d13c5610****
WorkTypestring

作品类型。取值范围:

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • FULLPAGE:全屏仪表板
  • REPORT:电子表格
  • dashboardOfflineQuery:自助取数
  • ANALYSIS:即席分析
  • DATAFORM:表单填报
PAGE
OwnerNamestring

作品所有者的昵称。

李四
WorkspaceNamestring

作品所属工作空间名称。

测试工作空间
OwnerIdstring

作品所有者在 Quick BI 的 UserID。

作品所属工作空间名称。
ModifyNamestring

作品修改者的昵称。

张三
WorkspaceIdstring

作品所属工作空间的 ID。

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

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

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

    作品备注。

    备注
    WorkNamestring

    作品名称。

    测试报表
    GmtCreatestring

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

    1496651577000
    Directoryobject

    作品所属目录。

    PathIdstring

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

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

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

    测试目录
    Namestring

    所属目录名称。

    所属目录名称。
    Idstring

    所属目录 ID。

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

    示例

    正常返回示例

    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****"
            }
          }
        ]
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    400Internal.System.ErrorAn internal system error occurred.系统内部异常。
    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.操作组件不存在或已被删除。

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

    • 本页导读 (0)
    文档反馈