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": "04cbcdb7-f7e5-264b-3c57-89f5841aeb64",
"groups": [
"1d61044ec2d927e5d45939f4",
"5987e54102faa10562364bf1",
"208cc2a736b6ab2da5cd8bc8",
"4de245c95ccfcb3e4d7aa89d"
],
"created": "1994-06-19T07:33:20.114Z",
"created_by": "9947709fc7ecb455b6b6e4f4",
"last_updated": "2006-03-23T22:28:06.638Z",
"last_updated_by": "933fcec00f7551a4889ff04d"
},
"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
{
"title": "result",
"type": "boolean"
}