批量更新或创建数据

PUT

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

根据指定的依据字段，找到一条数据后，用其他字段更新数据，单次最多批量处理 100 条数据。
如果更新模式为“upsert”，则会在没有找到数据时，使用全部字段创建新数据。
如果找到多条数据，则不会执行更新。
创建或更新数据时，如果提供了系统字段，如“item_id”，则仅可用作更新的依据字段，不会用来更新或创建数据。
注意：该接口为异步调用，将通过回调事件推送执行结果，详见”订阅回调事件“。

请求参数

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

Body 参数application/json

table_id

string

表格ID

必需

update_type

enum<string>

更新模式

必需

枚举值:

updateupsert

update_by_fields

array[string]

更新依据字段

必需

可指定多个更新依据的系统字段和自定义字段的 ID 列表，进行联合唯一判断，如填写了“item_id”则会忽略传入的其他字段，仅使用“item_id”作为更新依据

items

array [object {2}]

数据

必需

更新或创建的数据列表

item_id

string

数据ID

可选

如在“更新依据字段”中指定了 item_id 则必须提供，仅用作更新数据的依据字段

fields

object

字段值

必需

如在“更新依据字段”中指定了对应的字段则必须提供该字段及值

示例

{
  "table_id": "{{TABLE_ID}}",
  "update_type": "upsert",
  "update_by_fields": [
    "item_id"
  ],
  "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/items' \
--header 'Open-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "table_id": "",
    "update_type": "upsert",
    "update_by_fields" : [
        "item_id"
    ],
    "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

返回数据

必需

返回具体数据的结构