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

数据集预览接口(支持筛选行数据

POST
/public-api/data-source/{dsId}/data

请求参数

Path 参数

Header 参数

Body 参数application/json

示例
{
  "offset": 0,
  "limit": 1000,
  "filter": {
    "combineType": "AND",
    "conditions": [
      {
        "not": false,
        "type": "condition",
        "value": {
          "name": "id",
          "filterType": "GT",
          "filterValue": ["1"]
        }
      }
    ]
  }
}

请求示例代码

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": 1000,
  "filter": {
    "combineType": "AND",
    "conditions": [
      {
        "not": false,
        "type": "condition",
        "value": {
          "name": "id",
          "filterType": "GT",
          "filterValue": ["1"]
        }
      }
    ]
  }
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "result": "ok",
    "response": {
        "dsId": "f8002e3f5801743cc930e551",
        "name": "测试excel",
        "displayType": "MYSQL",
        "storageId": "f8002e3f5801743cc930e551",
        "domId": "demo",
        "uId": "b1766b1ac99bf4679a1bd762",
        "parentDirId": "bbf86c8c533064a34a972bf7",
        "cnId": "mysql",
        "acId": "c73a5244dffce4c41b138ab0",
        "rowCount": 1,
        "colCount": 2,
        "status": "FINISHED",
        "columns": [// 字段信息
            {
                "name": "id",
                "fdType": "INT",
                "dsId": "f8002e3f5801743cc930e551",
                "fdId": "k4936dfe957a0406c9379040",
                "metaType": "METRIC",
                "seqNo": 0,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "value",
                "fdType": "STRING",
                "dsId": "f8002e3f5801743cc930e551",
                "fdId": "k13d0bcc0fb61465ca9bbd9e",
                "metaType": "DIM",
                "seqNo": 1,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            }
        ],
        "ctime": "2024-03-18 11:30:36+0800",
        "utime": "2024-03-19 19:10:27+0800",
        "version": 4,
        "cardCount": 0,
        "preview": [ // data 信息,顺序按照columns里的字段顺序排列
            [
                "1",
                "xxx"
            ]
        ]
    }
}
修改于 2025-07-16 03:18:58
上一页
数据集删除
下一页
提供修改SQL模型结构接口