Summary
Search Forms
Description
Search forms with options
Route
POST /formbuilder/forms/search
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
options | object | yes | filter, skip, limit, sort, and project data |
{ "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" } ], "elements": [ { "type": "method", "id": { "name": "method_name_1" } } ], "_id": "a20d735d-fcd8-6fef-b1c5-e91cb6ce8cd8", "groups": [ "ea8f12b1ce6f4df325670c9f" ], "created": "1986-11-13T23:50:31.573Z", "created_by": "37e12eb5ba46e2c2eeeef0a0", "last_updated": "1955-10-28T13:18:06.152Z", "last_updated_by": "ed6b2243f5cbebd7321bf889" }, { "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": "be827c86-40e2-728c-bde4-5ee6e2650184", "groups": [ "f947ab8656675ff40f586f4e", "9fad1574cb524bdaaaba34a3", "4fbad49f81743318e92b0ac2", "4a80ecc1054f1ac27677ec75" ], "created": "1966-02-04T07:27:32.441Z", "created_by": "ade227c16cd3e580e03042e2", "last_updated": "2012-07-27T16:47:59.228Z", "last_updated_by": "dd91f064778dbb425fa5aa0a" }, { "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": "a9addcaa-f0bc-f2ec-b6e6-5e6a396d95c4", "groups": [ "36eb2dea4e4e554ff19bc517", "07ec531d91e035963cfcdec8", "648f528e4fa0af5a16214642", "a6cacf1a99aae07229b3de38" ], "created": "1957-04-25T06:33:18.959Z", "created_by": "51adb9568d1494938e8fd711", "last_updated": "1978-10-15T14:52:31.968Z", "last_updated_by": "2c8e12056f4714b73e7a4486" }, { "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": "e5332c8c-ab8a-b050-a184-5521b9d38f7e", "groups": [ "f6d96774ec90f9af74d113fa" ], "created": "2020-05-28T23:25:28.664Z", "created_by": "c0afd29586a8cbfecf052e78", "last_updated": "1965-01-03T14:38:40.789Z", "last_updated_by": "5cebd670c9250a2cf10bb1df" }, { "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": "83256dab-1019-d478-6a58-73636158c375", "groups": [ "fb8cd5844da616bd5831ca4a" ], "created": "1987-03-11T02:26:19.339Z", "created_by": "a75b2c7d6247c7936c2d73c6", "last_updated": "1995-01-26T22:28:59.617Z", "last_updated_by": "3fe2af7886247ccbe4ccdb08" } ]
{ "title": "data", "type": "array", "items": { "$ref": "formDocument" } }