テーブルデータの更新

このAPIを使用して、Agentデータテーブル内の指定したレコードの値を一括で更新することができます。1回のリクエストで最大100件のレコードを更新できます。

注意：
JSONリクエストボディ全体のサイズは5MBまでに制限されています。
1回のリクエストで更新できるレコード数は最大100件です。

リクエストメソッド

POST

エンドポイント

https://api.${endpoint}gptbots.ai/v2/database/update/record

認証

認証方法の詳細については、API概要の認証セクションをご参照ください。

リクエスト

リクエスト例

curl -X POST 'https://api-${endpoint}gptbots.ai/v2/database/update/record' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "table_id": "673af861ed69656ac0895b07", "is_create": true, "update_data":[ { "record_id":"123456", "updated_fields": { "name": "andy", "age": "30" } }, { "filter": { "id": "789" }, "updated_fields": { "name": "mop", "age": "32" } } ] }'

                      
                      curl -X POST 'https://api-${endpoint}gptbots.ai/v2/database/update/record' \ 
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
      "table_id": "673af861ed69656ac0895b07",
      "is_create": true,
      "update_data":[
        {
          "record_id":"123456",
          "updated_fields": {
          "name": "andy",
          "age": "30"
          }
        },
        {
          "filter": {
            "id": "789"
          },
          "updated_fields": {
          "name": "mop",
          "age": "32"
          }
        }
      ]
    }'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	型	説明
Authorization	Bearer ${API Key}	`Authorization: Bearer ${API Key}`形式で認証を行います。API キーは API キーページで取得してください。
Content-Type	application/json	データ形式は application/json を指定します。

リクエストボディ

フィールド	型	必須	説明
table_id	string	はい	テーブルID。
is_create	bool	いいえ	指定されたターゲットレコードが存在しない場合、新しいレコードを作成するかどうか。
update_data	list	はい	更新するデータの集合。
record_id	string	いいえ	`record_id` と `filter` のいずれかを指定する必要があります。`record_id` の使用を推奨します。
filter	map	いいえ	ユーザー定義のフィルター条件。`"unique": true` を含むフィールドが必要で、1つのフィールドのみサポートされます。
updated_fields	list	はい	更新するフィールドの集合。

注意

record_id と filter はどちらか一方を指定する必要があります。両方が指定された場合は、record_id が優先されます。

is_create のデフォルト値は false です。

is_create が指定されていない場合、新しいレコードは自動的に作成されません。

is_create が true に設定されている場合、更新対象データの record_id または filter がテーブル内に存在しない場合、そのレコードは自動的に新規追加されます。

レスポンス

レスポンス例

{ "totalCount": 4, "success_count": 2, "fail_count": 2, "fail_detail": [ { "upsert_data": { "record_id": "123456", "value": { "name": "测试用户", "email": "invalid_email" } }, "fail_reason": "邮箱格式不正确" }, { "upsert_data": { "filter": { "id": "789" }, "value": { "name": "测试用户", "email": "invalid_email" } }, "fail_reason": "邮箱格式不正确" } ] }

                      
                      {
    "totalCount": 4,
    "success_count": 2,
    "fail_count": 2,
    "fail_detail": [
        {
            "upsert_data": {
                "record_id": "123456",
                "value": {
                    "name": "测试用户",
                    "email": "invalid_email"
                }
            },
            "fail_reason": "邮箱格式不正确"
        },
        {
            "upsert_data": {
                "filter": {
                    "id": "789"
                },
                "value": {
                    "name": "测试用户",
                    "email": "invalid_email"
                }
            },
            "fail_reason": "邮箱格式不正确"
        }
    ]
}

このコードブロックをポップアップで表示

成功レスポンス

フィールド	型	説明
totalCount	int	更新タスクの総データ行数
success_count	string	更新に成功した行数
fail_count	string	更新に失敗した行数
fail_detail	array	更新失敗の詳細情報
upsert_data	array	該当行の更新リクエストデータ
fail_reason	array	該当行の更新失敗理由

エラーレスポンス

フィールド	型	説明
code	int	エラーコード
message	string	エラーメッセージ

エラーコード

コード	メッセージ
40000	パラメータエラー
50000	システム内部エラー
403106	テーブルが見つかりません
403131	テーブルへのアクセス権限がありません