观远数据开放平台
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/update-setting
目前仅支持批量更新数据集的文件夹路径或者数据集的属性更新,如果只需要更新路径位置,则只传递 propsInDetails 参数即可。
propsInDetails 和 settingsInDetails 的更新互不影响,即前者更新失败,后者还是会继续执行更新,除非两个都失败则返回前者的报错。

请求参数

Body 参数application/json
token
string 
应用Token
必需
在观远平台管理员设置-系统集成-统一账户集成中获得
propsInDetails
array [object {2}] 
数据集路径配置
可选
dsId
string 
数据集ID
必需
dsDir
string 
数据集所在文件夹的ID
必需
settingsInDetails
array [object {6}] 
数据集其他参数配置(如更新时间,更新方式)
可选
dsId
string 
数据集ID
必需
cron
object 
更新设置
必需
按月更新:每月6,7号的凌晨3点更新
guanIndexIncrementalUpdateSetting
object 
增量更新设置
可选
realTimeUpdateSetting
object  | null 
是否支持实时卡片数据
可选
tokenSetting
object 
是否URL触发
可选
retryCapable
object 
失败重试
可选
示例
{
    "token": "dolore in ea cupidatat non",
    "propsInDetails": [
        {
            "dsId": "97",
            "dsDir": "laborum pariatur Excepteur"
        }
    ],
    "settingsInDetails": [
        {
            "dsId": "12",
            "guanIndexIncrementalUpdateSetting": {
                "enabled": false,
                "query": "et",
                "preClean": {
                    "enabled": false,
                    "rule": "do dolor"
                }
            },
            "realTimeUpdateSetting": null,
            "tokenSetting": {
                "action": "laborum aliqua"
            },
            "retryCapable": {
                "enable": false,
                "retryConfig": {
                    "interval": 43,
                    "unit": "irure anim"
                }
            },
            "cron": {
                "cronType": "MONTHLY",
                "value": "eu"
            }
        },
        {
            "dsId": "87",
            "guanIndexIncrementalUpdateSetting": {
                "enabled": false,
                "query": "sit anim",
                "preClean": {
                    "enabled": false,
                    "rule": "quis"
                }
            },
            "realTimeUpdateSetting": null,
            "tokenSetting": {
                "action": "nostrud Duis in"
            },
            "retryCapable": {
                "enable": false,
                "retryConfig": {
                    "interval": 17,
                    "unit": "ipsum aliqua ad cillum commodo"
                }
            },
            "cron": {
                "cronType": "default",
                "value": "commodo Ut officia cillum ex"
            }
        }
    ]
}

示例代码

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/update-setting' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "dolore in ea cupidatat non",
    "propsInDetails": [
        {
            "dsId": "97",
            "dsDir": "laborum pariatur Excepteur"
        }
    ],
    "settingsInDetails": [
        {
            "dsId": "12",
            "guanIndexIncrementalUpdateSetting": {
                "enabled": false,
                "query": "et",
                "preClean": {
                    "enabled": false,
                    "rule": "do dolor"
                }
            },
            "realTimeUpdateSetting": null,
            "tokenSetting": {
                "action": "laborum aliqua"
            },
            "retryCapable": {
                "enable": false,
                "retryConfig": {
                    "interval": 43,
                    "unit": "irure anim"
                }
            },
            "cron": {
                "cronType": "MONTHLY",
                "value": "eu"
            }
        },
        {
            "dsId": "87",
            "guanIndexIncrementalUpdateSetting": {
                "enabled": false,
                "query": "sit anim",
                "preClean": {
                    "enabled": false,
                    "rule": "quis"
                }
            },
            "realTimeUpdateSetting": null,
            "tokenSetting": {
                "action": "nostrud Duis in"
            },
            "retryCapable": {
                "enable": false,
                "retryConfig": {
                    "interval": 17,
                    "unit": "ipsum aliqua ad cillum commodo"
                }
            },
            "cron": {
                "cronType": "default",
                "value": "commodo Ut officia cillum ex"
            }
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
result
string 
必需
response
string 
必需
示例
{
    "result": "ok",
    "response": "Done"
}
🔴500服务器错误
修改于 2024-12-24 07:52:01
上一页
查询特定数据集的数据结构
下一页
获取指定数据集有使用权限的用户列表