观远数据开放平台
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
首页官网社区
文档
  • 帮助中心
  • 观远学堂
首页官网社区
文档
  • 帮助中心
  • 观远学堂
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
  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/search

请求参数

Query 参数
q
string 
必需
要搜索的数据集名称模糊词
示例值:
xx
offset
integer 
搜索结果的起始位置
可选
示例值:
0
limit
integer 
可选
从起始位置取多少条
示例值:
10
Body 参数application/json
token
string 
应用Token
必需
在观远平台管理员设置-系统集成-统一账户集成中获得
示例
{
    "token": "string"
}

示例代码

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/search?q=xx&offset=0&limit=10' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string"
}'

返回响应

🟢200成功
application/json
Body
result
string 
必需
response
object 
必需
offset
integer 
必需
limit
integer 
必需
total
integer 
必需
list
array [object {14}] 
必需
示例
{
    "result": "ok",
    "response": {
        "offset": 0,
        "limit": 3,
        "total": 3,
        "list": [
            {
                "dsId": "wa292d4218d084f45b3eaa1d",
                "name": "test-模拟数据-图片",
                "displayType": "EXCEL",
                "domId": "testing",
                "uId": "m5b7407230a3a4fda87b8f6b",
                "parentDirId": "efae4f1696f024d599bba4f0",
                "rowCount": 222,
                "colCount": 20,
                "status": "FINISHED",
                "ctime": "2019-08-10 16:06:01+0800",
                "utime": "2023-10-20 11:57:54+0800",
                "cardCount": -587
            },
            {
                "dsId": "a453e73832c6d4f9b9465724",
                "name": "larry-test",
                "displayType": "FEEDBACK",
                "domId": "testing",
                "uId": "a3afc4292ef0f44208f28826",
                "parentDirId": "efae4f1696f024d599bba4f0",
                "cnId": "postgresql",
                "acId": "PG",
                "rowCount": 6,
                "colCount": 6,
                "status": "FINISHED",
                "ctime": "2019-08-20 11:01:46+0800",
                "utime": "2023-01-04 17:54:08+0800",
                "cardCount": 1
            },
            {
                "dsId": "i7c02e4bb11474aacbc6d4c8",
                "name": "test_direct33",
                "displayType": "MYSQL",
                "domId": "testing",
                "uId": "x72da161d0d484dc59db750c",
                "parentDirId": "efae4f1696f024d599bba4f0",
                "cnId": "mysql",
                "acId": "re11b545b0b384785ab1c4c4",
                "rowCount": 4987,
                "colCount": 8,
                "status": "FINISHED",
                "ctime": "2019-08-15 19:40:14+0800",
                "utime": "2022-08-02 15:54:23+0800",
                "cardCount": 0
            }
        ]
    }
}
修改于 2024-12-24 07:52:01
上一页
获取数据集列表
下一页
查询特定数据集的数据结构