观远数据开放平台
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
  • 7.0.1
首页官网社区
文档
  • 帮助中心
  • 观远学堂
首页官网社区
文档
  • 帮助中心
  • 观远学堂
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
  • 7.0.1
  1. 数据集
  • 默认模块
    • 开发指南
      • Token 鉴权
      • 常见问题
    • 用户
      • 批量创建用户
      • 批量删除用户
      • 批量修改用户属性
      • 批量查询用户是否存在
      • 获取用户列表
      • 修改指定用户状态
      • 通过指定的用户的loginid查询对应的uid
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
      • 用户统一登出
      • 通过用户属性值查询用户列表
      • 通过指定用户的loginid登录
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 数据集
      • 使用parquet文件更新数据集
        GET
      • 获取数据集列表
        POST
      • 搜索数据集列表
        POST
      • 查询特定数据集的数据结构
        POST
      • 批量修改数据集更新方式
        POST
      • 获取指定数据集有使用权限的用户列表
        POST
      • 上传数据
        POST
      • 获取数据集下载授权Token
        GET
      • 下载数据集数据
        POST
      • 获取数据集数据
        POST
      • 创建数据集
        POST
      • 更新数据集字段注释
        POST
      • 触发数据集读取数据文件并更新
        GET
      • 通过 TaskID 查询数据集更新结果
        GET
      • 修改数据集schema
        POST
      • 更新数据集
        POST
      • 修改数据集字段别名
        POST
    • 仪表板
      • 获取页面列表
      • 根据页面名称关键词搜索页面
      • 获取指定页面有读权限的用户列表
      • 以树状结构获取页面列表
      • 以PDF或者图片模式导出仪表板
      • 获取仪表板导出文件
    • 订阅预警
      • 下载自定义渠道推送文件
      • 启用/关闭订阅
      • 启用/关闭预警
    • 卡片
      • 获取卡片数据
    • 权限
      • 获取指定用户能访问的页面列表
      • 获取指定用户能访问的数据集列表
      • 修改指定用户与各个页面的访问及归属关系
      • 修改指定用户与各个数据集的访问及归属关系
      • 获取指定用户组能访问的页面列表
      • 获取指定用户组能访问的数据集列表
      • 修改指定用户组与各个页面的访问及归属关系
      • 修改指定用户组与各个数据集的访问及归属关系
      • 通用资源权限授权与解除
    • 资源操作
      • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
      • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
      • 通用资源列表清单
    • 用户登录
      POST
  1. 数据集

获取数据集数据

POST
/public-api/data-source/{dsId}/data
该api一次最多返回5万行数据,若数据集较大,请指定过滤条件。
注:5.10.0版本以上BI开始支持该接口

请求参数

Path 参数

Header 参数

Body 参数application/json

示例
{
    "offset": 0,
    "limit": 0,
    "filter": {
        "combineType": "AND",
        "conditions": [
            {
                "type": "condition",
                "value": {
                    "name": "string",
                    "filterType": "GT",
                    "filterValue": [
                        "string"
                    ]
                }
            }
        ]
    },
    "sortFactor": {
        "name": "string",
        "sortType": "desc"
    }
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/public-api/data-source//data' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "offset": 0,
    "limit": 0,
    "filter": {
        "combineType": "AND",
        "conditions": [
            {
                "type": "condition",
                "value": {
                    "name": "string",
                    "filterType": "GT",
                    "filterValue": [
                        "string"
                    ]
                }
            }
        ]
    },
    "sortFactor": {
        "name": "string",
        "sortType": "desc"
    }
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "result": "ok",
    "response": {
        "dsId": "v2a769c4be17d4ec8b77b2b2",
        "name": "对比订阅测试",
        "displayType": "EXCEL",
        "storageId": "v2a769c4be17d4ec8b77b2b2",
        "domId": "testing",
        "uId": "h2afb13f76d4843e298e4f4f",
        "parentDirId": "efae4f1696f024d599bba4f0",
        "rowCount": 6,
        "colCount": 4,
        "status": "FINISHED",
        "columns": [
            {
                "name": "省",
                "fdType": "STRING",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "teebf36bc63d94e7ebe6b4bc",
                "metaType": "DIM",
                "seqNo": 0,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "性别",
                "fdType": "STRING",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "o0ed08788ea9949909986db2",
                "metaType": "DIM",
                "seqNo": 1,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "订单数",
                "fdType": "LONG",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "j9a566f3ee11144f9a5f9f8e",
                "metaType": "METRIC",
                "seqNo": 2,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "客单价",
                "fdType": "LONG",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "eedec668e19c34b578687e34",
                "metaType": "METRIC",
                "seqNo": 3,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            }
        ],
        "ctime": "2024-10-09 18:53:36+0800",
        "utime": "2024-10-11 09:47:50+0800",
        "version": 2,
        "cardCount": 1,
        "preview": [
            [
                "浙江",
                "男",
                "1",
                "3"
            ],
            [
                "浙江",
                "女",
                "2",
                "4"
            ],
            [
                "上海",
                "男",
                "5",
                "7"
            ],
            [
                "上海",
                "女",
                "6",
                "8"
            ],
            [
                "江苏",
                "男",
                "2",
                "3"
            ],
            [
                "江苏",
                "女",
                "5",
                "3"
            ]
        ]
    }
}
修改于 2025-07-16 03:18:58
上一页
下载数据集数据
下一页
创建数据集