テーブルデータの削除

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

リクエストメソッド

POST

エンドポイント

https://api-${endpoint}/v2/database/delete/record

認証

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

リクエスト

リクエスト例

curl -X POST 'https://api-${endpoint}/v2/database/delete/record' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "table_id": "673af861ed69656ac0895b07", "delete_data":[ { "record_id":"123456", }, { "filter": { "id": "789" } ] }'

                      
                      curl -X POST 'https://api-${endpoint}/v2/database/delete/record' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
      "table_id": "673af861ed69656ac0895b07",
      "delete_data":[
        {
          "record_id":"123456",
        },
        {  
          "filter": {
          "id": "789"
        }
      ]
    }'

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

リクエストヘッダー

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

リクエストボディ

フィールド	型	必須	説明
table_id	string	はい	テーブルID
delete_data	array	はい	削除するデータの配列
record_id	string	いいえ	レコードID（record_idまたはfilterのいずれかを指定。record_idの使用を推奨）
filter	map	いいえ	カスタムフィルター条件（カスタム一意主キーフィールドを使用する必要があります）

注意：record_idとfilter条件のいずれかを指定する必要があります。record_idの使用を推奨します。両方が指定された場合、record_idが優先されます。

レスポンス

レスポンス例

{ "code": 0, "message": "OK" }

                      
                      {
    "code": 0,
    "message": "OK"
}

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

成功レスポンス

フィールド	型	説明
code	int	メッセージタイプコード
message	string	メッセージの説明

エラーレスポンス

フィールド	型	説明
code	int	エラーコード
message	string	エラーの詳細

エラーコード

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