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": "e6498ad8-58f4-508d-83d3-52d73b41e151",
"groups": [
"8c72315b8dee692f4f60c011",
"f52905a0cd7538fb1b5a5355"
],
"created": "1999-11-18T18:44:19.44Z",
"created_by": "f768967e984fa165cdaaf24a",
"last_updated": "1962-07-17T15:54:32.944Z",
"last_updated_by": "3293a614dc5cbe2ed78fe3f0"
},
"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"
}