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": "93b40De1-9c16-8c8A-Bebb-D791d2c5fbd7"
}
}
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": "080e024e-3cb4-62be-b0bb-c65b5d27a39f",
"groups": [
"93bf192a7b2fc4ca0b4d5aeb",
"19dbba9c0066b34c65c21418",
"ff1f10cf2f71f3a91f6948e2",
"48209ac5bdd7312e7d77dcb6"
],
"created": "1978-11-14T18:12:27.051Z",
"created_by": "43064b297748bf977cc27152",
"last_updated": "1995-06-14T06:13:44.698Z",
"last_updated_by": "32cd046599c4f5957d72ce82"
}