观远数据开放平台
首页
官网
社区
文档
版本
当前版本V7.0.0
观远数据开放平台
  • Token 鉴权
  • 用户
  • 用户组
  • 角色
  • 数据集
    • 使用parquet文件更新数据集GET
    • 获取数据集列表POST
    • 搜索数据集列表POST
    • 查询特定数据集的数据结构POST
    • 批量修改数据集更新方式POST
    • 获取指定数据集有使用权限的用户列表POST
    • 上传数据POST
    • 获取数据集下载授权TokenGET
    • 下载数据集数据POST
    • 获取数据集数据POST
    • 创建数据集POST
    • 更新数据集字段注释POST
    • 触发数据集读取数据文件并更新GET
    • 通过 TaskID 查询数据集更新结果GET
    • 修改数据集schemaPOST
    • 更新数据集POST
    • 修改数据集字段别名POST
    • 修改数据集名称POST
    • 修改数据集路径POST
    • 数据集删除POST
    • 数据集预览接口(支持筛选行数据POST
    • 提供修改SQL模型结构接口POST
    • 获取数据集目录列表的接口,支持指定目录搜索POST
    • 批量查询数据集基本信息POST
    • 批量查询数据集权限信息POST
  • 仪表板
  • 卡片
  • 订阅预警
  • 权限
  • 资源操作
  • 卡片导出
  • 文件夹
  • 用户登录POST
亮色模式

    创建数据集

    POST/public-api/data-source/create-from-account

    注意:当数据集类型为 Guan-Index 时,primaryKeyColumns不填为不去重,填写参数格式为:[“column1”, “column2”],column 代表去重列名。

    请求参数

    Body 参数application/json
    token
    string 
    应用Token
    必需

    在观远平台管理员设置-系统集成-统一账户集成中获得

    acId
    string 
    数据账户ID
    必需
    name
    string 
    数据集名称
    必需
    parentDirId
    string 
    目录ID
    可选

    创建的数据集将放在此目录下。
    当不传时,数据集默认放在根目录下。具体值可以在浏览器访问目录后在地址栏中获取。

    cron
    object 
    更新设置
    可选

    若不传则默认为手动更新。
    按月更新:每月6,7号的凌晨3点更新"cron": { "cronType": "MONTHLY", "value": "{"minute":"00","hours":"03","dom":"6,7"}"}

    cronType
    enum<string> 
    定时更新类型
    必需
    枚举值:
    defaultDAILYWEEKLYMONTHLY
    默认值:
    default
    value
    string 
    定时更新配置json字符串
    必需
    tableQuery
    object 
    生成数据集所使用的SQL语句
    必需
    queryType
    string 
    必需

    SQL查询类型,本接口固定传参为“query”

    table
    string 
    必需

    数据集所使用表的表名

    query
    string 
    必需

    创建数据集所使用的SQL语句

    sourceType
    enum<string> 
    数据集类型
    必需
    枚举值:
    DIRECT_CONNECT_DATABASEGUAN_INDEX
    realTimeUpdateSetting
    object  | null 
    实时卡片数据设置
    必需
    enabled
    boolean 
    是否开启支持实时卡片数据
    必需
    interval
    integer 
    目前固定为600
    必需
    disableCache
    boolean 
    是否开启缓存
    必需
    primaryKeyColumns
    array[string]
    去重主键
    可选

    填写参数格式为:["column1", "column2"]

    guanIndexIncrementalUpdateSetting
    object 
    增量更新设置
    可选
    enabled
    boolean 
    是否开启增量更新
    必需
    query
    string 
    增量更新所使用的SQL语句
    必需
    示例
    {
      "token": "string",
      "acId": "string",
      "name": "string",
      "parentDirId": "string",
      "cron": {
        "cronType": "default",
        "value": "string"
      },
      "tableQuery": {
        "queryType": "string",
        "table": "string",
        "query": "string"
      },
      "sourceType": "DIRECT_CONNECT_DATABASE",
      "realTimeUpdateSetting": {
        "enabled": true,
        "interval": 0,
        "disableCache": true
      },
      "primaryKeyColumns": [
        "string"
      ],
      "guanIndexIncrementalUpdateSetting": {
        "enabled": true,
        "query": "string"
      }
    }

    示例代码

    返回响应

    成功(200)
    服务器错误(500)
    HTTP 状态码: 200
    内容格式: JSONapplication/json
    数据结构
    result
    string 
    必需
    response
    object 
    必需
    taskId
    string 
    必需
    status
    string 
    必需
    result
    string 
    必需
    dsId
    string 
    必需
    示例
    {
      "result": "ok",
      "response": {
        "taskId": "1b6e0ab0-8798-11ef-894c-b1b9ab6ee927",
        "status": "已提交",
        "result": "处理中",
        "dsId": "e5063f6ac9fff44d1a385b9e"
      }
    }
    最后修改时间: 5 个月前
    上一页
    POST获取数据集数据
    下一页
    POST更新数据集字段注释
    举报