批量修改数据集更新方式

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": "应用token",
  "propsInDetails": [
    {
      "dsId": "dsId",
      "dsDir": "dirId"
    }
  ],
  "settingsInDetails": [
    {
      "dsId": "dsId",
      "guanIndexIncrementalUpdateSetting": {
        "enabled": true,
        "query": "select 1",
        "preClean": { "enabled": false, "rule": "`“编号”`>2" }
      },
      "realTimeUpdateSetting": {
        "enabled": true,
        "interval": 600,
        "disableCache": false,
        "cacheType": "GLOBAL"
      },
      "tokenSetting": {
        "action": "enable"
      },
      "retryCapable": {
        "enable": true,
        "retryConfig": { "interval": 5, "unit": "MINUTE" }
      },
      "cron": {
        "enableSchedule": true,
        "cronType": "DAILY",
        "value": "{\"minute\":\"01\",\"hours\":\"01\"}"
      }
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/data-source/update-setting' \
--header 'Content-Type: application/json' \
--data-raw '{
  "token": "应用token",
  "propsInDetails": [
    {
      "dsId": "dsId",
      "dsDir": "dirId"
    }
  ],
  "settingsInDetails": [
    {
      "dsId": "dsId",
      "guanIndexIncrementalUpdateSetting": {
        "enabled": true,
        "query": "select 1",
        "preClean": { "enabled": false, "rule": "`“编号”`>2" }
      },
      "realTimeUpdateSetting": {
        "enabled": true,
        "interval": 600,
        "disableCache": false,
        "cacheType": "GLOBAL"
      },
      "tokenSetting": {
        "action": "enable"
      },
      "retryCapable": {
        "enable": true,
        "retryConfig": { "interval": 5, "unit": "MINUTE" }
      },
      "cron": {
        "enableSchedule": true,
        "cronType": "DAILY",
        "value": "{\"minute\":\"01\",\"hours\":\"01\"}"
      }
    }
  ]
}'

返回响应

🟢200成功

application/json

Body

result

string

请求状态

必需

枚举值: ok、fail

response

string

响应结果

必需

示例

{
    "result": "ok",
    "response": "Done"
}

🔴500服务器错误

修改于 2025-02-28 07:08:30

查询特定数据集的数据结构

获取指定数据集有使用权限的用户列表