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

Search forms

POST
http://localhost:3000/formbuilder/forms/search
POST
/formbuilder/forms/search
$curl -X POST http://localhost:3000/formbuilder/forms/search \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1[
2  {
3    "name": "Form 123",
4    "elements": [
5      {
6        "type": "method",
7        "id": {
8          "name": "method_name_1"
9        }
10      }
11    ],
12    "children": [
13      {
14        "id": "string",
15        "type": "container",
16        "properties": {
17          "type": "leafref",
18          "path": "/ncs:devices/ncs:device/ncs:name",
19          "min": "1",
20          "max": "4",
21          "minLength": "1",
22          "maxLength": "4",
23          "default": "string",
24          "direction": "vertical",
25          "required": true,
26          "enforce": true,
27          "hidden": true
28        },
29        "element": "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}",
30        "name": "vlan_id_123",
31        "display_name": "vlan",
32        "source_type": "service_model",
33        "source": "/ncs:services/abc_devices:ios.device",
34        "key": "service.vlanid"
35      }
36    ],
37    "_id": "string",
38    "groups": [
39      "string"
40    ],
41    "created": "2024-01-15T09:30:00Z",
42    "last_updated": "2024-01-15T09:30:00Z"
43  }
44]
Searches forms with options.
Was this page helpful?
Previous

Add a new certificate

Next
Built with

Authentication

AuthorizationBasic

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

Request

request body
optionsobjectOptional

Response

Array of objects containing forms
namestring
elementslist of objects
childrenlist of objects
_idstringformat: "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"
groupslist of strings
createdstringformat: "date-time"
created_byany
last_updatedstringformat: "date-time"
last_updated_byany

Errors

500
Internal Server Error