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": {
"_id": "A78a7CA4-c3BC-aeee-6baF-E887cf44fAf0"
}
}
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"
}
],
"elements": [
{
"type": "method",
"id": {
"name": "method_name_1"
}
}
],
"_id": "c52f536e-3472-91bf-44ed-31a8e57fa3df",
"groups": [
"cdd4dd820d51d70ddc4b62c9",
"b8d7a2bd5c8e9f91d1fbe1b9",
"51ae5a1f2f550a401215ad32",
"4ce1f59a8e7b30d37615713b"
],
"created": "1984-07-09T20:15:14.611Z",
"created_by": "2b42876adb61148e058459c3",
"last_updated": "2017-05-02T21:19:36.186Z",
"last_updated_by": "5683f1cc51009d8d15ab6f6a"
}