メインコンテンツへスキップ

レコード削除 API

Canbus. チーム
  • 更新

レコード削除 API を使用すると、アプリ内の指定されたレコードを削除できます。

  • エンドポイント URL - https://<tenant-id>.canbus.com/api/records
  • メソッド - DELETE

 

リクエストヘッダーの形式

以下のリクエストヘッダーが必要です。

  • Content-Type: application/json

 

リクエストボディの形式

レコード削除 API のリクエストボディ形式は次のとおりです。

{
    "tenant_id": <tenant-id>,
    "app_id": <app-id>,
    "api_key": <api-key>,
    "api_secret": <api-secret>,
    "delete": [
        {
            "_id": <record-object-id>,
            "System_Delete_User": <user-login-id>
        },
        ...
    ]
}

淡色部分には、Canbus. API の認証情報を挿入します。認証情報の送信方法については、認証を参照してください。

delete はオブジェクト配列です。削除するレコードを表す 1 個以上のオブジェクトを要素として指定します。各要素に含まれる _id は削除するレコードの ID を、System_Delete_User はレコードの削除者として記録するユーザーのログイン ID をそれぞれ表す文字列です。

実際の delete 配列は、例えば以下のようになります。

"delete": [
    {
        "_id": "660fa9bd6a831e0f4f02446f",
        "System_Delete_User": "admin"
    }, {
        "_id": "660a68da55b09b0c1815bc30",
        "System_Delete_User": "admin"
    }
]

このリクエストボディを送信すると、指定した 2 件のレコードがユーザー admin によって削除されます。

削除するレコードのレコード ID を確認するには、最初にレコード一覧 API を使用して対象レコードを取得してください。レコード作成 API を使用してレコードを作成した場合は、作成されたレコードの ID がレコード作成 API のレスポンスボディに格納されています。ID がレコード作成後に変更されることはありません。レコードの ID はレコード番号とは異なります。

 

レスポンスボディの形式

レコード削除 API のレスポンスボディ形式は次のとおりです。

{
    "authen": "OK",
    "results": [
        {
            "result": <result-code>,
            "id": <record-object-id>
        },
        ...
    ]
}

results は削除結果を表すオブジェクト配列です。リクエストボディの delete 配列の要素数と results の要素数は同じになり、互いの各要素が 1 対 1 で対応します。

レコード削除 API では、削除しようとしたレコードごとに以下の result コードが返されます。

  • 0 - 削除に成功
  • 32 - 指定されたログイン ID のユーザーが存在しない、または有効ではない
  • 7005 - 指定された ID のレコードが存在しない

各要素の id は、リクエストボディの delete 配列で指定されたレコード ID です。この値は、指定された ID のレコードが実際に削除されたかどうかに関わらず、レスポンスボディに含まれます。

 

関連情報

関連記事