レコード削除 API

レコード削除 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

                                             ・URL "aaa" は、お客様毎の テナントID を入力してください。

3. HTTP Request header  

ご使用いただいている外部ツールに、下記のヘッダーを設定します。

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 ステータスコード 一覧

 
・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