Summary
          Search Forms
          Description
          Search forms with options
          Route
          POST /formbuilder/forms/search
          Roles
          
            admin
apiread
operator
          
          Parameters
          
            DetailsExampleSchema
          
          
            
              
                | Name | 
                Type | 
                Required | 
                Description | 
              
            
            
              
    | options | 
    object | 
    yes | 
    filter, startAt, maxResults, sort, fields, expand | 
  
            
          
          
            Copied to Clipboard
            
            {
  "options": {
    "filter": {
      "name": "form_example_1"
    },
    "startAt": 0,
    "maxResults": 10,
    "sort": {
      "name": 1
    },
    "fields": [
      "name",
      "children",
      "elements",
      "createddBy",
      "created",
      "lastUpdatedBy",
      "lastUpdated"
    ],
    "expand": [
      "createdBy",
      "lastUpdatedBy"
    ]
  }
}
           
          
            Copied to Clipboard
            
            {
  "type": "object",
  "properties": {
    "options": {
      "title": "options",
      "type": "object",
      "properties": {
        "filter": {
          "type": "object",
          "examples": [
            {
              "name": "form_example_1"
            }
          ]
        },
        "startAt": {
          "type": "integer",
          "minimum": 0,
          "examples": [
            0
          ]
        },
        "maxResults": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100,
          "examples": [
            10
          ]
        },
        "sort": {
          "type": "object",
          "examples": [
            {
              "name": 1
            }
          ]
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "name",
              "children",
              "elements",
              "createddBy",
              "created",
              "lastUpdatedBy",
              "lastUpdated"
            ]
          },
          "examples": [
            [
              "name",
              "children",
              "elements",
              "createddBy",
              "created",
              "lastUpdatedBy",
              "lastUpdated"
            ]
          ],
          "uniqueItems": true
        },
        "expand": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "createdBy",
              "lastUpdatedBy"
            ]
          },
          "examples": [
            [
              "createdBy",
              "lastUpdatedBy"
            ]
          ],
          "uniqueItems": true
        }
      }
    }
  },
  "required": [
    "options"
  ],
  "additionalProperties": false
}
           
          Return
          
            DetailsExampleSchema
          
          
            
              
                | Name | 
                Type | 
                Description | 
              
            
            
              
                | data | 
                array | 
                Array of objects containing forms | 
              
            
          
          
            Copied to Clipboard
            
            [
  {
    "name": "Form 123",
    "children": [
      {
        "type": "field",
        "name": "ipaddress",
        "properties": {
          "type": "string",
          "prefix": ""
        },
        "description": "IP address",
        "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
        "source_type": "method",
        "source": "method_name_1",
        "id": "a40044c2-f378-4b2b-a81a-41d78979e583",
        "yangkey": "",
        "key": "method_name_1.ipAddress"
      },
      {
        "type": "field",
        "name": "ipaddress",
        "properties": {
          "type": "string",
          "prefix": ""
        },
        "description": "IP address",
        "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
        "source_type": "method",
        "source": "method_name_1",
        "id": "a40044c2-f378-4b2b-a81a-41d78979e583",
        "yangkey": "",
        "key": "method_name_1.ipAddress"
      },
      {
        "type": "field",
        "name": "ipaddress",
        "properties": {
          "type": "string",
          "prefix": ""
        },
        "description": "IP address",
        "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
        "source_type": "method",
        "source": "method_name_1",
        "id": "a40044c2-f378-4b2b-a81a-41d78979e583",
        "yangkey": "",
        "key": "method_name_1.ipAddress"
      },
      {
        "type": "field",
        "name": "ipaddress",
        "properties": {
          "type": "string",
          "prefix": ""
        },
        "description": "IP address",
        "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
        "source_type": "method",
        "source": "method_name_1",
        "id": "a40044c2-f378-4b2b-a81a-41d78979e583",
        "yangkey": "",
        "key": "method_name_1.ipAddress"
      }
    ],
    "elements": [
      {
        "type": "method",
        "id": {
          "name": "method_name_1"
        }
      }
    ],
    "_id": "fbbffb50-9073-0708-5d2c-77d3fa2b1b7f",
    "groups": [
      "88cc379b4ba238795ef8a048",
      "10971360db8e1dcf6c09254e"
    ],
    "created": "1986-07-14T13:27:03.599Z",
    "created_by": "46029b5912da3647df2a28a9",
    "last_updated": "1959-11-18T11:27:25.314Z",
    "last_updated_by": "0cd1225cd973406f990425e2"
  },
  {
    "name": "Form 123",
    "children": [
      {
        "type": "field",
        "name": "ipaddress",
        "properties": {
          "type": "string",
          "prefix": ""
        },
        "description": "IP address",
        "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}",
        "source_type": "method",
        "source": "method_name_1",
        "id": "a40044c2-f378-4b2b-a81a-41d78979e583",
        "yangkey": "",
        "key": "method_name_1.ipAddress"
      }
    ],
    "elements": [
      {
        "type": "method",
        "id": {
          "name": "method_name_1"
        }
      }
    ],
    "_id": "7b59e697-f5a5-d3dd-b9b9-d1d216d887a1",
    "groups": [
      "828dad7565ce086dc77b3d40"
    ],
    "created": "2013-11-05T18:11:57.628Z",
    "created_by": "261500ad92ae13b2e398838f",
    "last_updated": "1970-10-23T07:56:06.885Z",
    "last_updated_by": "7257d56adb5077864b894ee0"
  }
]
           
          
            Copied to Clipboard
            
            {
  "title": "data",
  "type": "array",
  "items": {
    "$ref": "formDocument"
  }
}