Summary
Get Details of Form by Name
Description
Get details for a specific form by name
Route
GET /formbuilder/getFormByName/:form_name
Roles
admin
apiread
operator
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| form_name |
string |
yes |
Form name |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| data |
object |
Forms details |
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"
},
{
"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": "abe53500-e971-0566-0e13-dd191ec5f657",
"groups": [
"27af58ac1b724e9769016af1",
"b11a05a7011bf1c763beb7d5",
"5221effe473223f34cbe15df",
"937a2025be5c371dd60a4d3a"
],
"created": "1962-07-01T16:05:43.341Z",
"created_by": "f57f34fc362726532920dbd7",
"last_updated": "1963-12-12T23:40:42.894Z",
"last_updated_by": "680171cf54ed8ee4a0d5b799"
}
