kintone API

添加多條記錄

創建多條記錄。

目錄

HTTP 方法POST
URLhttps://sample.cybozu.com/k/v1/records.json
URL(訪客空間)https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/records.json
認證 密碼驗證 , API令牌認證 , 會話認證 , OAuth認證
Content-Typeapplication/json

請求參數

參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
records 陣列(物件) 必須 要添加的記錄清單
根據欄位的類型,可以指定不同的值。
詳情請參閱以下頁面。
欄位格式
如果指定了空陣列,則所有欄位的值都將使用其初始值進行添加。
如果指定的欄位代碼不存在,則忽略該欄位並創建記錄。

回應屬性

屬性名稱 類型 說明
ids 陣列(字串) 您添加的記錄的記錄 ID。
revisions 陣列(字串) 已添加記錄的修訂號

記錄ID的順序與請求中指定的記錄的順序相對應。

所需存取權限

  • 應用程式的記錄添加權限
  • 要添加值的欄位的編輯權限

如果要添加以下欄位的值,則必須具有應用管理權限。

  • 建立人
  • 更新人
  • 建立時間
  • 更新時間

範例

1
2
3
4
{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規格

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "app": 1,
  "records": [
    {
      "單行文字方塊_0" : {
        "value": "ABC"
      },
      "單行文字方塊_1" : {
        "value": "ABC"
      }
    },
    {
      "單行文字方塊_0" : {
        "value": "EFG"
      },
      "單行文字方塊_1" : {
        "value": "EFG"
      }
    }
  ]
}

1
2
3
4
{
  "ids": ["100", "101"],
  "revisions": ["1", "1"]
}

有關kintone.api()的說明,請參閱以下頁面。
傳送kintone REST API請求

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const body = {
  app: kintone.app.getId(),
  records: [
    {
      單行文字方塊_0: {
        value: 'ABC'
      },
      單行文字方塊_1: {
        value: 'ABC'
      }
    },
    {
      單行文字方塊_0: {
        value: 'EFG'
      },
      單行文字方塊_1: {
        value: 'EFG'
      }
    }
  ]
};

await kintone.api(kintone.api.url('/k/v1/records.json', true), 'POST', body);

根據您的環境,curl的格式可能會有所不同。
有關說明,請參閱以下頁面。
使用curl命令執行kintone REST API中的3.執行API (日語)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
curl -X POST 'https://sample.cybozu.com/k/v1/records.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "records": [
      {
        "單行文字方塊_0" : {
          "value": "ABC"
        },
        "單行文字方塊_1" : {
          "value": "ABC"
        }
      },
      {
        "單行文字方塊_0" : {
          "value": "EFG"
        },
        "單行文字方塊_1" : {
          "value": "EFG"
        }
      }
    ]
  }'

補充

  • 一次最多可以添加 100 條記錄。
  • 如果設置了必填欄位,請將其包含在請求中。
  • 按照請求參數中 records 指定的順序添加記錄。
  • 如果處理失敗,則取消請求中指定的記錄的所有添加。

限制事項

  • 以下欄位的值無法更新:
    • 從Lookup源複製的欄位
    • 狀態
    • 類別
    • 計算
    • 執行者
    • 具有自動計算功能的單行字串欄位