Summary
Export Form
Description
Export a single Form
Route
POST /formbuilder/forms/export
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| options |
object |
yes |
match a form using _id or name |
Copied to Clipboard
{
"options": {
"name": "Form 123"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"type": "object",
"properties": {
"_id": {
"$ref": "formDocument#/definitions/uuidv4"
},
"name": {
"$ref": "formDocument#/definitions/formName"
}
},
"anyOf": [
{
"required": [
"_id"
]
},
{
"required": [
"name"
]
}
],
"additionalProperties": false
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| form |
object |
Exported Form |
Copied to Clipboard
{
"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": "2a836586-0cb4-50f2-b100-83700e7215c2",
"groups": [
"86fd689e4ae7950a3361c93b",
"6044029728dec01112ebd60c",
"1f1c17f4446f25351c32cab7",
"d961f39d6ac78f10df3038f6",
"d2806b84ff77a458b23bbc85"
],
"created": "1982-04-02T19:23:17.865Z",
"created_by": "55d9d632e049bab6cacc5cb3",
"last_updated": "2006-10-23T00:24:43.445Z",
"last_updated_by": "efb374001a892a3cfebac96c"
}
