Summary
Search Forms
Description
Search forms with options
Route
POST /formbuilder/forms/search
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
options | object | yes | filter, startAt, maxResults, sort, fields, expand |
{ "options": { "filter": { "name": "form_example_1" }, "startAt": 0, "maxResults": 10, "sort": { "name": 1 }, "fields": [ "name", "children", "elements", "createddBy", "created", "lastUpdatedBy", "lastUpdated" ], "expand": [ "createdBy", "lastUpdatedBy" ] } }
{ "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
Name | Type | Description |
---|---|---|
data | array | Array of objects containing forms |
[ { "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" }, { "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": "54d5433e-bdd4-c7aa-9fe4-d8c6c8060241", "groups": [ "5ea2c0c4e09ecee86c0fb83b" ], "created": "1979-11-20T04:34:44.094Z", "created_by": "a2a40b8f5d3dfdfd5b0f7d9d", "last_updated": "1992-12-12T23:31:35.636Z", "last_updated_by": "7c044a2ad6d269de1c34a11e" }, { "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": "6e1dc7d8-81db-06cb-7e60-28e0788ce579", "groups": [ "e8268c46b28bea994d80b885", "9726671781f040168126b2a4", "c7d25fb3dd7066ffad700b18", "1e997fbea1150939426cde24" ], "created": "2020-08-21T08:04:03.532Z", "created_by": "e2c74b1afb54da2ec296cc83", "last_updated": "1968-04-20T02:21:15.592Z", "last_updated_by": "5083d7cd627aba95db056f67" }, { "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" } ], "elements": [ { "type": "method", "id": { "name": "method_name_1" } } ], "_id": "e8d26809-4798-f24b-849d-f5483e44f5a6", "groups": [ "2fa90a1842277865f82c5eae", "ea76e209c925075fb4167c39", "14ff0b33f432835439a46601", "0aff0003a697381265a5f2d0", "8c0032b3c46e1a2785c6a9bc" ], "created": "2010-12-22T19:18:00.36Z", "created_by": "bd6e6e4c94907d4327cb7bfc", "last_updated": "2007-06-01T06:35:49.704Z", "last_updated_by": "775c3345b8505116f0cb0018" }, { "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" } ], "elements": [ { "type": "method", "id": { "name": "method_name_1" } } ], "_id": "28e65c60-c711-3c3e-1e70-34c6a2df52d7", "groups": [ "970ab4c43fd1640f4867047b", "eaa9004c78b291d4d7c78d72", "431447f5cb6d9b783f2c6d4c", "b3e8e67fa3455263353905d9", "a3f06665a5c18d778a04091a" ], "created": "1958-04-24T23:37:41.944Z", "created_by": "aa79c70bd1131c2444ed4d3b", "last_updated": "1989-11-30T17:22:25.898Z", "last_updated_by": "94fae853cd4d63d2bb096c25" }, { "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" } ], "elements": [ { "type": "method", "id": { "name": "method_name_1" } } ], "_id": "d7ef8e1e-b3b9-a864-99ce-b191eb0c4f7f", "groups": [ "995916c68811d612dd6c94ec", "fffeebfacc39e1206906949a" ], "created": "1977-03-24T03:12:17.608Z", "created_by": "6631cb2fb07afcf3e8198800", "last_updated": "2011-12-01T00:27:59.067Z", "last_updated_by": "680deea46cdf98a68cf77a89" } ]
{ "title": "data", "type": "array", "items": { "$ref": "formDocument" } }