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"
},
{
"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": "fd12faf3-5224-8db8-c8f4-282ecda3f6f1",
"groups": [
"abd928ee1f344d12116ffa38",
"6f322dc66e14a79e5c2d0656"
],
"created": "1993-05-31T14:36:04.254Z",
"created_by": "516a544e20369a6a928c1136",
"last_updated": "1953-10-03T03:27:14.287Z",
"last_updated_by": "ca6e2381232533c115d22c5b"
}