Get details of form by ID

GET

https://example.itential.io/formbuilder/getForm/:form_id

GET

/formbuilder/getForm/:form_id

$ curl https://example.itential.io/formbuilder/getForm/form_id \
>      -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         "default": "string",
18         "direction": "vertical",
19         "enforce": true,
20         "hidden": true,
21         "max": "4",
22         "maxLength": "4",
23         "min": "1",
24         "minLength": "1",
25         "path": "/ncs:devices/ncs:device/ncs:name",
26         "required": 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 }

Returns details for a specific form from by ID.

Authentication

AuthorizationBasic

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

Path parameters

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

Form ID

Response

Forms details

namestring

elementslist of objects

childrenlist of objects

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

groupslist of strings or maps from strings to anyOptional

createdstringOptionalformat: "date-time"

created_byanyOptional

last_updatedstringOptionalformat: "date-time"

last_updated_byanyOptional

Errors

500

Internal Server Error