レコード取得 API

レコード取得 API を使用することで、レコードの情報を取得することが可能です。

1. APIの基本形式

{
 ① "tenant_id": "test",
 ② "app_id": "aaaaaaaaaaaaaaa",
 ③ "api_key": "bbbbbbb",
 ④ "api_secret": "ccccccccccccccccc",
  "property": [
    {
      "System_Create_User": "admin",
      "Text": "レコード追加テスト",
      "Number": "1234",
    }
  ]
}

①. Canbus. のテナントID を入力します。（必須）
②. 各テーブルで発行される [API権限] の [アプリID] を入力します。（必須）
③. 各テーブルで発行される [API権限] の [APIキー] を入力します。（必須）
④. 各テーブルで発行される [API権限] の [APIシークレット] を入力します。（必須）

2. レコード取得 API

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

3. HTTP Request header 

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

4. Request body 

例としまして、レコードID : record_idのレコード情報を取得します。

レコード作成 API のリクエストボディは下記の通りとなります。

{
 ※"tenant_id": "test",
 ※"app_id": "aaaaaaaaaaaaaaa",
 ※"api_key": "bbbbbbb",
 ※"api_secret": "ccccccccccccccccc",
①"records": [
    ②"record_id",
  ]
}

　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　[※] は入力必須です。

① records
　 必須。レコード取得 API では property を "records" と入力します。

② record_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" or "NG"
② "results": [
   {
  ③ "result": 100, 
  ④ "id": 100, 
  ⑤ "length": [ 
   {
    ⑥"_id":"1111111111"
    ⑦"field_id":"aaaaaaaaaa"
    },
    {
      "_id":"2222222222"
      "field_id":"bbbbbbbbbb"
    ],
   }
  ]
 }

①  authen
      API 認証が成功した場合には "OK" が返されます。そうでない場合は "NG" が返されます。

②  results
      レコード作成の結果を表す情報が配列で返されます。

③  result
      レコード作成の結果を表すコード番号が返されます。
　   ※ Result code をご参照ください。

④  id
      オブジェクト配列

⑤ length
     返されたオブジェクトの配列の長さを返します。

⑥ _id
      取得したレコードID を返します。

⑦ field_id
　  情報を取得した項目ID を返します。

・Result code