レコード削除 API を使用することで、レコードの削除を行うことができます。
1. APIの基本形式
{ ① "tenant_id": "test", ② "app_id": "aaaaaaaaaaaaaaa", ③ "api_key": "bbbbbbb", ④ "api_secret": "ccccccccccccccccc", "property": [ {, } ] }
①. Canbus. のテナントID を入力します。(必須)
②. 各テーブルで発行される [API権限] の [アプリID] を入力します。(必須)
③. 各テーブルで発行される [API権限] の [APIキー] を入力します。(必須)
④. 各テーブルで発行される [API権限] の [APIシークレット] を入力します。(必須)
2. レコード削除 API
HTTP | URL |
DELETE | https://aaa.canbus.com/api/records |
・URL "aaa" は、お客様毎の テナントID を入力してください。
3. HTTP Request header
ご使用いただいている外部ツールに、下記のヘッダーを設定します。
ヘッダー | 値 |
Content-Type | "application/json" |
4. Request body
例としまして、レコードID ”1111111aaaaaaa2222222" のレコードと、
レコードID "3333333bbbbbbb4444444" のレコードを削除します。
レコード作成 API のリクエストボディは下記の通りとなります。
{ ※"tenant_id": "test", ※"app_id": "aaaaaaaaaaaaaaa", ※"api_key": "bbbbbbb", ※"api_secret": "ccccccccccccccccc",
①"delete": [ { ②"System_Delete_User": "admin",
③"_id":"1111111aaaaaaa2222222", },
{
"System_Delete_User": "admin",
"_id":"3333333bbbbbbb4444444"
} ] }
[※] は入力必須です。
① delete
必須。レコード削除 API では property を "delete" と入力します。
② System_Delete_User
必須。レコードを削除するユーザーを選択します。
③ _id
削除を行う対象レコードの、レコードID を入力します。
【_id(レコードID)の取得方法】 1. フィルターが適用されていることを確認した後、右クリック > [ページのソースを表示] (または ctrl + U)をクリックします。 2. ctrl + F で検索キーを表示していただき、「recordId」で検索をします。 3. 「"recordId"」横の「""(ダブルクォーテーション)」で囲われている24桁の値が「_id」(「record_id」)のIDとなります。
5. Response
・HTTP ステータスコード 一覧
コード | 判定 | 意味 |
201 Created | "authen": "OK" | 成功 |
400 Bad Request | "authen": "NG" | JSON形式不正 or API_ID不正 |
401 Unauthorized | "authen": "NG" | 認証失敗 |
403 Forbidden | "authen": "NG" | 接続元IP制限 |
404 Not Found | - | /api 以下の URL が不正 |
405 Method Not Allowed | "authen": "NG" | 無効な HTTP メソッドでアクセス |
413 Payload Too Large | "authen": "NG" | サイズ超過 |
429 Too Many Requests | "authen": "NG" | APIアクセス数制限 |
500 Internal Server Error | - | 予期せぬエラー |
・body data
※下記は例となります。
{
① "authen":"OK"
② "results": [
{
③ "result": "0" ,
④ "id": "aaaaaaaaaa"
},
{
"result": "0" ,
"id": "bbbbbbbbbb"
}
]
}
① authen
API 認証が成功した場合には "OK" が返されます。そうでない場合は "NG" が返されます。
② results
レコード削除の結果を表す情報が配列で返されます。
③ result
レコード作成の結果を表すコード番号が返されます。
※ Result code をご参照ください。
④ id
削除されたレコードの ID が返されます。
・Result code
コード | 意味 | レコード作成可否 |
0 | 成功 | 可 |
32 | System_Delete_User に指定されたユーザーが存在しない もしくは、無効となっている場合 |
否 |
7005 | 存在しないレコードIDを指定した場合 | 否 |