Get details of form by name

curl http://localhost:3000/formbuilder/getFormByName/form_name \
     -u "<username>:<password>"

{
  "name": "Form 123",
  "elements": [
    {
      "type": "method",
      "id": {
        "name": "method_name_1"
      }
    }
  ],
  "children": [
    {
      "id": "string",
      "type": "container",
      "properties": {
        "type": "leafref",
        "path": "/ncs:devices/ncs:device/ncs:name",
        "min": "1",
        "max": "4",
        "minLength": "1",
        "maxLength": "4",
        "default": "string",
        "direction": "vertical",
        "required": true,
        "enforce": true,
        "hidden": true
      },
      "element": "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}",
      "name": "vlan_id_123",
      "display_name": "vlan",
      "source_type": "service_model",
      "source": "/ncs:services/abc_devices:ios.device",
      "key": "service.vlanid"
    }
  ],
  "_id": "string",
  "groups": [
    {}
  ],
  "created": "2024-01-15T09:30:00Z",
  "last_updated": "2024-01-15T09:30:00Z"
}

Returns details for a specific form by name.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

form_namestringRequired

Form name

Response

Forms details

namestring

elementslist of objects

childrenlist of objects

_idstringformat: "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"

groupslist of strings or maps from strings to any

createdstringformat: "date-time"

created_byany

last_updatedstringformat: "date-time"

last_updated_byany

Errors

500

Internal Server Error

$	curl http://localhost:3000/formbuilder/getFormByName/form_name \
>	-u "<username>:<password>"

1	{
2	"name": "Form 123",
3	"elements": [
4	{
5	"type": "method",
6	"id": {
7	"name": "method_name_1"
8	}
9	}
10	],
11	"children": [
12	{
13	"id": "string",
14	"type": "container",
15	"properties": {
16	"type": "leafref",
17	"path": "/ncs:devices/ncs:device/ncs:name",
18	"min": "1",
19	"max": "4",
20	"minLength": "1",
21	"maxLength": "4",
22	"default": "string",
23	"direction": "vertical",
24	"required": true,
25	"enforce": true,
26	"hidden": true
27	},
28	"element": "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}",
29	"name": "vlan_id_123",
30	"display_name": "vlan",
31	"source_type": "service_model",
32	"source": "/ncs:services/abc_devices:ios.device",
33	"key": "service.vlanid"
34	}
35	],
36	"_id": "string",
37	"groups": [
38	{}
39	],
40	"created": "2024-01-15T09:30:00Z",
41	"last_updated": "2024-01-15T09:30:00Z"
42	}