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": "cAFcb8A4-8F5A-2F3f-3e78-0b1B5fb9bb4c"
}
}
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": "42861bf1-65e4-73e3-2a6b-6c8b1a6460ac",
"groups": [
"3aa3e805ec8380078187288b",
"e9ec6c3b1f3ba4510a378cc0",
"15048cc11f12b268c68e7f6f",
"d5f9f52b2467eda5afa2e238"
],
"created": "1996-02-03T15:24:16.335Z",
"created_by": "68cd43b96a7db010bc846e31",
"last_updated": "2024-11-01T12:48:19.882Z",
"last_updated_by": "be38dc6da104a8e426fbae45"
}
