レコード作成 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

例としまして、文字列項目(Text)にレコード追加、数値項目(Number)に "1234" を入力し、表組項目を2行追加するレコードと、文字列項目(Text)にレコード追加2、数値項目(Number)に "5678" を入力し、表組項目を2行追加するレコードを作成します。

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

{
 ※"tenant_id": "test",
 ※"app_id": "aaaaaaaaaaaaaaa",
 ※"api_key": "bbbbbbb",
 ※"api_secret": "ccccccccccccccccc",
①"add": [
    {
    ②"System_Create_User": "admin",
    ③"Text": "レコード追加",
      "Number": "1234",
    ④ "Table":[
         {
          "Text_2":"表組項目1行目",
          "Text_3":"表組項目1行目",
          },
           {
            "Text_2":"表組項目2行目",
            "Text_3":"表組項目2行目", 
           }
         ]
        },
        {
        "System_Create_User": "admin", 
        "Text": "レコード追加2",
        "Number": "5678"
　　　    "Table":[
           {
            "Text_2":"表組項目1行目",
            "Text_3":"表組項目1行目",
           },
             {
             "Text_2":"表組項目2行目",
             "Text_3":"表組項目2行目",
              },
            ]
          }
        ]
      }

　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　[※] は入力必須です。

① add
　 必須。レコード作成 API ではpropertyを "add" と入力します。

② System_Create_User
     必須。レコードを作成するユーザーを選択します。

③ field 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