For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd group to form
        • POSTDelete a form by ID
        • POSTExport form
        • GETGet an element definition
        • GETGet details of form by ID
        • GETGet details of form by name
        • POSTGet service instance data
        • POSTImport form
        • GETList all elements usable in forms
        • GETList all form names
        • GETList groups for a form
        • PUTOverwrite groups for a form
        • POSTPreserve incoming form data format
        • DELRemove a group from a form
        • DELRemove all authorization restriction for a form
        • POSTSave a generated form
        • POSTSearch forms
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceFormbuilder

Get details of form by ID

GET
http://localhost:3000/formbuilder/getForm/:form_id
GET
/formbuilder/getForm/:form_id
$curl http://localhost:3000/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        "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}
Returns details for a specific form from by ID.
Was this page helpful?
Previous

Get details of form by name

Next
Built with

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
_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