新建多筆資料 API調試
簡介
API 簡介
透過新建多筆資料 API,可以向指定的表單中新增多筆資料。
附註:
使用 API 新增資料時,會觸發的事件有新資料送出通知、彙總表計算&校驗、資料操作日誌、資料量統計。也可以透過請求參數來控制是否發起流程。但是不會觸發重複值校驗、必填校驗。
另外,系統欄位和以下所列舉的欄位不支援新增和修改資料:
- 分割線
- 手寫簽名
- 選擇資料、查詢
- 流水號(送出後系統生成)
API版本說明
API版本 | 更新時間 | 版本說明 |
V1 | 2022.10.28 | API請求頻率由 5 次/秒提升至 10 次/秒; 參數 app_id 和 entry_id 放入 body,API 路由修改為 POST app/entry/data/batch_create。 |
2023.08.31 | 新增請求參數
|
API調用
建立多筆資料 API 最多支援 100 筆資料。
請求地址:https://api.jodoo.com/api/v5/app/entry/data/batch_create
請求頻率:10 次/秒
請求方式:POST
請求參數:
參數 | 類型 | 必需 | 說明 | 預設 |
app_id | String | 是 | 應用 ID | / |
entry_id | String | 是 | 表單 ID | / |
data_list | Array | 是 | 資料內容陣列 | / |
data_creator | String | 否 | 資料送出人(取成員編號 username,可從通訊錄 API 取得) | 企業建立者 |
transaction_id | String | 否 | 事務ID;transaction_id 用於表示一次事務,用於防止因重試而導致重複建立同一批資料,也用於綁定一批文件,建議使用 UUID 以免重複。 | / |
is_start_workflow | Bool | 否 | 是否發起流程(僅流程表單有效) | false |
請求範例:
{
"app_id": "59264073a2a60c0c08e20bfb",
"entry_id": "59264073a2a60c0c08e20bfd",
"transaction_id": "87cd7d71-c6df-4281-9927-469094395677", //事務ID
"data_list": [
{
"_widget_1432728651402": { // 單行文字
"value": "Jodoo1"
},
"_widget_1432728651403": { // 數字
"value": 100
},
"_widget_1528854613291": { // 子表單
"value": [
{ // 子表單子記錄結構跟主表一致
"_widget_1528854614409": {
"value": "子表單資料11"
},
"_widget_1528854615499": {
"value": 1001
}
},
{
"_widget_1528854614410": {
"value": "子表單資料12"
},
"_widget_1528854615419": {
"value": 1002
}
}
]
}
},
{
"_widget_1432728651402": {
"value": "Jodoo2"
},
"_widget_1432728651403": {
"value": 200
},
"_widget_1528854613291": {
"value": [
{
"_widget_1528854614409": {
"value": "子表單資料21"
},
"_widget_1528854615499": {
"value": 2001
}
}
]
}
},
{
"_widget_1432728651402": {
"value": "Jodoo3"
},
"_widget_1432728651403": {
"value": 300
},
"_widget_1528854613291": {
"value": [
{
"_widget_1528854614410": {
"value": "子表單資料31"
},
"_widget_1528854615419": {
"value": 3001
}
}
]
}
}
],
"is_start_workflow": true
}
回應內容:
參數 | 類型 | 說明 |
status | String | 返回請求結果 |
success_count | Number | 建立成功的資料筆數 |
success_ids | Array | 建立成功的資料的ID列表 |
回應範例:
{
"status": "success",
"success_count": 3,
"success_ids": [
"200001181fe09728936510eb",
"200001181fe09728936510ec",
"200001181fe09728936510ed"
]
}
注意事項
1. 新建多筆資料,部分資料新建時可能出現失敗的情況。處理方法如下所示:
使用同一個 transaction_id 再次請求新建多筆,傳入全部資料。執行效果將為新增第一次失敗的資料,第一次成功的資料不會重複新增。
2. 如果請求中指定了 data_creator,則關聯觸發的以下成員也會被記錄為 data_creator,如下所示:
- 智慧助手執行人
- 流程發起人