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": "1d77b58d-5c35-d67c-060e-b12265122e88", "groups": [ "3aa4408af269f382bf7d1046", "77684b03f69bd6924571aaa2", "c9a189094f3bbeafe2a7b3ec" ], "created": "1980-08-08T21:06:07.574Z", "created_by": "c5d75f00fead9eb85dc0c8c9", "last_updated": "2017-12-06T05:08:03.766Z", "last_updated_by": "fb8a89b8b0c644ff395db3af" }, { "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": "c70363d2-49f2-fd4e-48ad-c42a2300af23", "groups": [ "fbe0ac5cf9c565d2c834802b", "1676d7030613211a060dc9ec" ], "created": "2008-06-27T08:33:35.117Z", "created_by": "73e7b16809b6435843eb5a23", "last_updated": "1953-07-28T05:03:17.104Z", "last_updated_by": "972eafd903dbbb044223024f" }, { "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": "dbe4f013-5eff-1096-50c1-e2cd9bfaaf5c", "groups": [ "e31852ee0bf24451f7d1be46" ], "created": "1987-12-13T23:42:56.836Z", "created_by": "d5e7f013276d333e88d767d5", "last_updated": "2001-04-27T03:42:53.522Z", "last_updated_by": "c1a1f43fb150f1731d03f620" }, { "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": "120e78f4-fb05-e41b-a6ca-7453a19ac6ad", "groups": [ "cc3e52e23002207fb2d5e356" ], "created": "1982-07-30T13:33:24.811Z", "created_by": "f2da263401dcaf5ef5e424f7", "last_updated": "1991-12-28T20:02:48.081Z", "last_updated_by": "31be2a3683936523ed431c98" } ]
{ "title": "data", "type": "array", "items": { "$ref": "formDocument" } }