Search forms | Itential

curl -X POST http://localhost:3000/formbuilder/forms/search \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{}'

[
  {
    "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": [
      "string"
    ],
    "created": "2024-01-15T09:30:00Z",
    "last_updated": "2024-01-15T09:30:00Z"
  }
]

Searches forms with options.

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