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": "E4809BA0-2c0C-E9be-ceEd-7a57aa3cE5E5"
}
}
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": "af44c867-8e8c-50f8-5635-21b27e027296",
"groups": [
"73d8cf6090fc5ab4073440a3",
"695428f14120063ed287bcae",
"53a04f600318140d95a4ef18",
"68590cf0e840333dba21e925"
],
"created": "1977-04-04T10:56:03.583Z",
"created_by": "80157f88e1fc3e253bd947d4",
"last_updated": "1957-05-04T15:12:30.357Z",
"last_updated_by": "d8ddc11854c4740ddca20da3"
}