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": "3cbF6bfE-bB7C-21DB-4A79-bCA724264270"
}
}
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": "bc2cad6e-744b-0a46-cf97-a7295fd06895",
"groups": [
"a658c6273533572f4c101445",
"dfef8759cee61efeffb8e396",
"79b4cbc77b38e59cad95aa43",
"4cbe2859bc66e5c3d0497580",
"0f42f9ff1c1d49acea09b5d9"
],
"created": "1973-10-29T07:35:26.627Z",
"created_by": "ceb0b33ab31a7d28f27b5659",
"last_updated": "1944-05-18T09:08:05.096Z",
"last_updated_by": "403298713847cf8ed2163040"
}