Summary
Save a Generated Form
Description
Save a generated form with its data.
Route
POST /formbuilder/saveForm
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
formData |
object |
yes |
Form data to be saved. |
Copied to Clipboard
{
"formData": {
"name": "Form 123",
"children": [
{
"type": "field",
"name": "ipaddress",
"properties": {
"type": "string",
"prefix": ""
},
"description": "IP address",
"element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
"source_type": "method",
"source": "method_name_1",
"id": "a40044c2-f378-4b2b-a81a-41d78979e583",
"yangkey": "",
"key": "method_name_1.ipAddress"
},
{
"type": "field",
"name": "ipaddress",
"properties": {
"type": "string",
"prefix": ""
},
"description": "IP address",
"element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
"source_type": "method",
"source": "method_name_1",
"id": "a40044c2-f378-4b2b-a81a-41d78979e583",
"yangkey": "",
"key": "method_name_1.ipAddress"
},
{
"type": "field",
"name": "ipaddress",
"properties": {
"type": "string",
"prefix": ""
},
"description": "IP address",
"element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
"source_type": "method",
"source": "method_name_1",
"id": "a40044c2-f378-4b2b-a81a-41d78979e583",
"yangkey": "",
"key": "method_name_1.ipAddress"
}
],
"elements": [
{
"type": "method",
"id": {
"name": "method_name_1"
}
}
],
"_id": "47032fe0-f46e-4a93-dd9e-d733bcbc18bd",
"groups": [
"f67f04a840b6f46582acacdb",
"446329f390d9b6f08910721b",
"c6bbd845319c644d0c1705d7"
],
"created": "2025-01-05T22:43:39.465Z",
"created_by": "8023be00fba5f48129670eff",
"last_updated": "2000-01-12T08:01:01.232Z",
"last_updated_by": "852e5d17cfd608571b4d7f5b"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"formData": {
"title": "formData",
"$ref": "formDocument"
}
},
"required": [
"formData"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
reply |
object |
Status of save form |
Copied to Clipboard
{
"name": "Form 123",
"children": [
{
"type": "field",
"name": "ipaddress",
"properties": {
"type": "string",
"prefix": ""
},
"description": "IP address",
"element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
"source_type": "method",
"source": "method_name_1",
"id": "a40044c2-f378-4b2b-a81a-41d78979e583",
"yangkey": "",
"key": "method_name_1.ipAddress"
},
{
"type": "field",
"name": "ipaddress",
"properties": {
"type": "string",
"prefix": ""
},
"description": "IP address",
"element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
"source_type": "method",
"source": "method_name_1",
"id": "a40044c2-f378-4b2b-a81a-41d78979e583",
"yangkey": "",
"key": "method_name_1.ipAddress"
},
{
"type": "field",
"name": "ipaddress",
"properties": {
"type": "string",
"prefix": ""
},
"description": "IP address",
"element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
"source_type": "method",
"source": "method_name_1",
"id": "a40044c2-f378-4b2b-a81a-41d78979e583",
"yangkey": "",
"key": "method_name_1.ipAddress"
}
],
"elements": [
{
"type": "method",
"id": {
"name": "method_name_1"
}
}
],
"_id": "6453c128-fcc3-248c-07a4-cf46b5287dd2",
"groups": [
"7bc30ae9980733da4d860881",
"3bd21004cdc1f28fb8a1eb0b",
"11ea371a363dab7e9dfa3978",
"d0c0269d904a101a913ba16a"
],
"created": "2008-08-03T23:40:34.916Z",
"created_by": "47512c10220a429bb0517ee8",
"last_updated": "2021-02-07T15:31:26.009Z",
"last_updated_by": "97c28950c12aad1df5e3aa16"
}