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": "042c72d7-8ba1-ee9c-db6c-5b5f4eef0f93",
"groups": [
"2181b4e3e05681fe5f3105f6",
"ad9254cb0172af2f29070208",
"ade58151e8b13fbc1adf0d97",
"361569a00644e4cc8c9f49f8",
"8cfa0f4bad836dc8f9d3a395"
],
"created": "2013-01-10T07:40:08.919Z",
"created_by": "a13d60d0e286d57c26887ae0",
"last_updated": "2001-12-26T22:56:59.615Z",
"last_updated_by": "19ea3b7ebf3542fb4475227f"
},
"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"
}