文档

QueryWorksByOrganization - 查询组织下的所有作品

更新时间:

查询整个组织下的所有作品,可指定作品类型。

调试

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

授权信息

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

请求参数

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

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

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

查询作品的状态。取值范围:

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

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

  • 0:暂未开通嵌入
  • 1:已开通嵌入
1
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
Dataarray<object>

作品列表详情。

Dataobject
Statusinteger

报表状态。取值范围:

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

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

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

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

1572334870000
WorksIdstring

作品 ID。

897ce25e-****-****-af84-d13c5610****
WorkTypestring

作品类型。取值范围:

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

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

李四
WorkspaceNamestring

作品所属工作空间名称。

测试工作空间
OwnerIdstring

作品所有者在 Quick BI 的 UserID。

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

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

张三
WorkspaceIdstring

作品所属工作空间的 ID。

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

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

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

    作品备注。

    备注
    WorkNamestring

    作品名称。

    测试报表
    GmtCreatestring

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

    1496651577000
    Directoryobject

    作品所属目录。

    PathIdstring

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

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

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

    测试目录
    Namestring

    所属目录名称。

    测试目录
    Idstring

    所属目录 ID。

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

    是否公开

    true
    PublicInvalidTimelong

    报表公开的截止日期

    1721366354000

    示例

    正常返回示例

    JSON格式

    {
      "Success": true,
      "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
      "Result": {
        "TotalPages": 1,
        "PageNum": 1,
        "PageSize": 10,
        "TotalNum": 1,
        "Data": [
          {
            "Status": 1,
            "Auth3rdFlag": 1,
            "GmtModify": "1572334870000",
            "WorksId": "897ce25e-****-****-af84-d13c5610****",
            "WorkType": "PAGE",
            "OwnerName": "李四",
            "WorkspaceName": "测试工作空间",
            "OwnerId": "作品所属工作空间名称。",
            "ModifyName": "张三",
            "WorkspaceId": "作品修改者的阿里云账户名。",
            "SecurityLevel": "1",
            "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错误码错误信息描述
    400Internal.System.ErrorAn internal system error occurred.系统内部异常。

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

    变更历史

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