更新数据

PUT

https://api.huoban.com/openapi/v1/dw_item

在数据仓库的指定表格中，根据指定的依据字段，找到一条数据后，用其他字段更新数据，单次最多批量处理 100 条数据。
如果更新模式为“upsert”，则会在没有找到数据时，使用全部字段创建新数据。
如果找到多条数据，则不会执行更新，同时会返回失败数据。创建或更新字段时，如果提供了系统字段，如 item_id 则仅可用作更新的依据字段，不会用来更新或创建数据。
仅支持操作 ext 类型的大数据表，可到企业账户页面中确认拥有“大数据表总量”资源时，可联系客户经理协助创建 ext 类型的大数据表。
注意：该接口为异步调用，将通过回调事件推送执行结果，详见”订阅回调事件“。

请求参数

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

Body 参数application/json

table_id

string

表格ID

必需

update_type

string

更新模式

必需

更新模式，update:代表仅依赖items.[].item_id更新; upsert:代表根据items.[].item_id或update_by_fields查找数据，items.[].item_id优先，找到数据则更新，未找到则新增

update_by_fields

array[string]

更新依赖字段

可选

update_type为upsert时生效，可指定多个更新依赖的字段，进行联合唯一判断

items

array [object {2}]

数据

必需

item_id

string | null

数据ID

必需

update_type为update时，不可为空；update_type为upsert时，如有值，则优先使用item_id进行匹配，如没有值, 则使用 update_by_fields 进行匹配

fields

object (字段提交)

字段值

必需

update_type为upsert时，如在update_by_fields中指定了对应的字段则必须包含该字段及值

示例

{
  "table_id": "{{EXT_TABLE_ID}}",
  "update_type": "update",
  "update_by_fields": [
    "2200000137810772",
    "2200000137811680"
  ],
  "items": [
    {
      "item_id": "2300002213303374",
      "fields": {
        "2200000137810772": "单行文本101",
        "2200000137811680": "多行文本1\n多行文本1\n多行文本1"
      }
    },
    {
      "item_id": "2300002213303371",
      "fields": {
        "2200000137810772": "单行文本102",
        "2200000137811680": "多行文本2\n多行文本2\n多行文本2"
      }
    },
    {
      "item_id": "2300002213303372",
      "fields": {
        "2200000137810772": "单行文本103",
        "2200000137811680": "多行文本3\n多行文本3\n多行文本3"
      }
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.huoban.com/openapi/v1/dw_item' \
--header 'Open-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "table_id": "{{EXT_TABLE_ID}}",
    "update_type": "update",
    "update_by_fields":[
        "2200000137810772",
        "2200000137811680"
    ],
    "items": [
        {
            "item_id": "2300002213303374",
            "fields": {
                "2200000137810772": "单行文本101",
                "2200000137811680": "多行文本1\n多行文本1\n多行文本1"
            }
        },
        {
            "item_id": "2300002213303371",
            "fields": {
                "2200000137810772": "单行文本102",
                "2200000137811680": "多行文本2\n多行文本2\n多行文本2"
            }
        },
        {
            "item_id": "2300002213303372",
            "fields": {
                "2200000137810772": "单行文本103",
                "2200000137811680": "多行文本3\n多行文本3\n多行文本3"
            }
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

0 为成功，小于 10000 为系统异常，其他为业务异常

message

string

错误信息

必需

具体的错误原因，code 为 0 时返回“success”

data

object

返回数据

必需

返回具体数据的结构