Summary
Import Form
Description
Import a single Form
Route
POST /formbuilder/forms/import
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| form |
object |
yes |
A form payload object |
| options |
object |
yes |
Import options: adapterMap (optional) |
Copied to Clipboard
{
"form": {
"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"
}
],
"elements": [
{
"type": "method",
"id": {
"name": "method_name_1"
}
}
],
"_id": "ad284022-0439-b8b4-6ad9-df6913257ca8",
"groups": [
"84f2ce83fd37fe29a21bb242"
],
"created": "1955-05-05T08:21:21.696Z",
"created_by": "646233d6f41abe302642c51f",
"last_updated": "1950-03-05T11:01:08.712Z",
"last_updated_by": "6f8d7eda21bac7e0cbd71e7a"
},
"options": {}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"form": {
"title": "form",
"$ref": "formDocument"
},
"options": {
"title": "options",
"type": "object",
"properties": {
"adapterMap": {
"type": "object"
}
}
}
},
"required": [
"form",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
boolean |
Import status |
Copied to Clipboard
false
Copied to Clipboard
{
"title": "result",
"type": "boolean"
}