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"
},
{
"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": "c9392a07-2607-5f88-78c9-cafb1047363f",
"groups": [
"e46e981e6012f6cc87b5ecb2",
"eaa57950b04b95ec72a8da44"
],
"created": "1947-07-24T20:02:13.226Z",
"created_by": "4d1b08ac261763daf109da24",
"last_updated": "1946-06-04T08:32:17.891Z",
"last_updated_by": "69d383dd33c21ef5c3bf7563"
}