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"
}
],
"elements": [
{
"type": "method",
"id": {
"name": "method_name_1"
}
}
],
"_id": "ed22f4a9-cae9-cac5-a8c0-a93f01e1f168",
"groups": [
"bc29e9f8943c1282a1b41743",
"ad38fe0cb99ae6757dce7edb",
"f23b6058382eeae6d219c073",
"8b8e99ce1cc27bd896fe469e",
"4f2827ca12223646d90c5fc8"
],
"created": "2014-06-24T13:16:17.497Z",
"created_by": "c8d42a27ef9ef3be21ba2cf5",
"last_updated": "1954-04-18T10:04:36.731Z",
"last_updated_by": "3845478c1484c2af1d3fcd68"
},
"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"
}