Single Record Creation APIAPI Explorer
Introduction
API Introduction
You can add one record to a certain form through the Single Record Creation API.
Note:
If you use the API to create a record, the following events can be triggered: record submission notifying, aggregation table calculation & validation, data operation log recording, and data volume statistics. It is also possible to decide whether to initiate a workflow through request parameters. However, validations on duplicate value and required field will not be triggered.
Records creating and updating are forbidden in the system fields and the following fields.
- Divider
- Signature
- RelatedData and RelatedQuery
- Serial No. (Automatically generated)
Version Description
API Version | Updated Time | Version Description |
V 1 | 2022.10.28 | The API request frequency is increased from five times per second to 20 times per second. The parameters "app_id" and "entry_id" are put in the body and the API route changed to "POST app/entry/data/create". |
2023.08.31 | A new request parameter "data_creator" is added. |
API Calling
Add a record to a certain form.
Request URL: https://api.jodoo.com/api/v5/app/entry/data/create
Request Frequency: 20 times per second
Request Method: POST
Request Parameters:
Parameter | Type | Required | Description | Default |
app_id | String | Yes | App ID | / |
entry_id | String | Yes | Form ID | / |
data | JSON | Yes | Records to add. | / |
data_creator | String | No | The member who submits data. The value for "data_creator" is the member's NO.. You can obtain the member number through the contact APIs. | Business owner |
is_start_workflow | Bool | No | Whether to initiate workflows (Only work in workflow forms) | false |
is_start_trigger | Bool | No | Whether to trigger Automations | false |
transaction_id | String | No | Transaction ID (transaction_id) is used to bind a batch of uploaded files. If the data includes attachments or images, the transaction_id must be the same as that in the API for accessing upload credentials and URL. | / |
Request Example:
{
"app_id": "59264073a2a60c0c08e20bfb",
"entry_id": "59264073a2a60c0c08e20bfd",
"transaction_id": "87cd7d71-c6df-4281-9927-469094395677", //Transaction ID
"data": {
"_widget_1432728651402": { // Single Line
"value": "Jodoo"
},
"_widget_1432728651403": { // Number
"value": 100
},
"_widget_1432728651404": { // Multi Line
"value": "Jodoo is a powerful and easy-to-use tool to build apps. \nIt can make your ideas come true "
},
"_widget_1432728651405": { // Radio, Single Select
"value": "Option 1"
},
"_widget_1432728651406": { // Checkbox,Multi Select
"value": [
"Option 1, Option 2, Option 3"
]
},
"_widget_1432728651407": { // Date&Time
"value": "2018-01-01T10:10:10.000Z"
},
"_widget_1432728651412": { // Address
"value": {
"province": "United Kingdom",
"city": "London",
"district": "Westminster",
"detail": "10 Downing Street"
}
},
"_widget_1432728651413": { // Locate
"value": {
"province": "United Kingdom",
"city": "London",
"district": "Westminster",
"detail": "10 Downing Street",
"lnglatXY": [
120.31237,
31.49099
]
}
},
"_widget_1528854613291": { // Subform
"value": [
{ // The structure of subform records are the same as that of form records
"_widget_1528854614409": {
"value": "Subform record 1"
},
"_widget_1528854615499": {
"value": 100
}
},
"_widget_1652345009126": { //Member（a member's username）
"value": "jian"
},
"_widget_1652345009143": { //Members (members' username array）
"value": [
"Joo",
"do"
]
},
"_widget_1652345009157": { //Department（a department's dept_no）
"value": 12
},
"_widget_1652345009174": { //Departments（departments' dept_no array）
"value": [
12,
13
]
},
"_widget_1432728651408": { // Attachment（File key array）
"value": ["6b559cf1-b16c-43bd-a211-8fa8fdeae2ef","6b559cf1-b16c-43bd-a211-646ab85da8cb"]
},
"_widget_1432728652567": { // Image（File key array）
"value": ["6b559cf1-b16c-43bd-a211-74389cd8ae76","6b559cf1-b16c-43bd-a211-564e56a65bd6"]
},
"_widget_1432728651408": { // Attachment（File key array）
"value": ["6b559cf1-b16c-43bd-a211-8fa8fdeae2ef","6b559cf1-b16c-43bd-a211-646ab85da8cb"]
},
"_widget_1432728652567": { // Image（File key array）
"value": ["6b559cf1-b16c-43bd-a211-74389cd8ae76","6b559cf1-b16c-43bd-a211-564e56a65bd6"]
}
}
}Responses:
Parameter | Type | Description |
data | JSON | Return the complete records after submission, with the same content as the Single Record Query API. |
{
"data": {
"_id": "59e9a2fe283ffa7c11b1ddbf",
"appId": "59264073a2a60c0c08e20bfb",
"entryId": "59264073a2a60c0c08e20bfd",
"creator": {
"name": "Jodoo",
"username": "Jodoo",
"status": 1,
"type": 0,
"departments": [1, 3],
"integrate_id": "Jodoo"
},
"updater": {
"name": "Jodoo",
"username": "Jodoo",
"status": 1,
"type": 0,
"departments": [1, 3],
"integrate_id": "Jodoo"
},
"createTime": "2017-10-20T22:41:51.430Z", // Created Time
"updateTime": "2017-10-20T11:12:15.293Z", // Updated Time
"_widget_1432728651402": "Jodoo", // Single Line
"_widget_1432728651403": 100, // Number
"_widget_1432728651404": "Jodoo is a powerful and easy-to-use to build apps. It can make your ideas come true", // Multi Line
"_widget_1432728651405": "Option 1", // Radio, Single Select
"_widget_1432728651406": [ // Checkbox, Multi Select
"Option 1, Option 2, Option 3"
],
"_widget_1432728651407": "2018-01-01T10:10:10.000Z", // Date&Time
"_widget_1432728651408": { // RelatedData
"id": "5b28effa49b561455dfda91e",
"key": "Jodoo"
},
"_widget_1432728651409": [ // Image
{
"name": "image.jpg",
"size": 262144,
"mime": "image/jpeg",
"url": "https://files.jiandaoyun.com/lepxaifzcapghupffcaswikmhnyp"
}
],
"_widget_1432728651410": [ // Attachment
{
"name": "Product Documentation.pdf",
"size": 524288,
"mime": "application/pdf",
"url": "https://files.jiandaoyun.com/bogrebbkdbkfsbuldnjujoenclle"
}
],
"_widget_1432728651411": { // Signature
"name": "image.png",
"size": 262144,
"mime": "image/png",
"url": "https://files.jiandaoyun.com/sxbikbrchwlylrgqwyfkjbjmuncp"
},
"_widget_1432728651414": { // Member
"name": "Jodoo",
"username": "Jodoo",
"status": 1,
"type": 0,
"departments": [1, 3],
"integrate_id": "Jodoo"
},
"_widget_1432728651415": [ // Members
{
"name": "Jodoo",
"username": "Jodoo",
"status": 1,
"type": 0,
"departments": [1, 3],
"integrate_id": "Jodoo"
}
],
"_widget_1432728651416": { // Department
"name": "Manager Department",
"dept_no": 1,
"type": 0,
"parent_no": 2,
"status": 1,
"integrate_id": 1
},
"_widget_1432728651417": [ // Departments
{
"name": "Manager Department",
"dept_no": 1,
"type": 0,
"parent_no": 2,
"status": 1,
"integrate_id": 1
}
],
"_widget_1432728651408": [ // SubForm
{
// ...
}
],
}
}