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" } ], "elements": [ { "type": "method", "id": { "name": "method_name_1" } } ], "_id": "ee723408-5457-3db1-4f6e-308e0c848b0d", "groups": [ "44a3719cf4b7712baf8a5054", "9cfe44f54f36c7ebd9c64a01", "0199290e73f797fe27aa5f46", "bffe8e141f909d3c57d12899" ], "created": "1957-08-12T09:19:56.757Z", "created_by": "7a83260ee4c78c5bef5a5522", "last_updated": "1977-01-27T01:34:42.595Z", "last_updated_by": "583a913a0d241728666ab2dc" }, { "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": "58ccbb62-7667-1ed1-a383-7d2bf92ed8c6", "groups": [ "cdf28856c07ab62470d283ca", "2ec522212b4c3364d62769c4", "74e9ef91eff8f9fc26a2fbd3", "4cbf0a9b0ff70e1e320085dc", "5f1ed93a23ee80e4db9baff6" ], "created": "2015-09-09T08:56:11.306Z", "created_by": "1a8f7d09fdda2243fa6d8b34", "last_updated": "2020-07-09T15:55:36.947Z", "last_updated_by": "0fe8d7f688cd8b7a1e62079c" }, { "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": "17faf1a0-f10a-22c5-3514-ac2a48cca25a", "groups": [ "b86a51827d11ff09bafacd1b", "6fdb018dd6dc2439494660c5", "2527041bc93676c1f8dc9c6a", "0b2c9ef4ff223fc5727ff3c2", "f207c1ff05850c17124ed6a0" ], "created": "1956-06-04T03:55:24.093Z", "created_by": "8da6ba9fd0262f392f7c48e5", "last_updated": "1997-06-23T15:29:10.174Z", "last_updated_by": "9e0bb937dd8f333cd6aaed40" }, { "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": "15915218-369a-c6d8-e100-e2b14b9b2af8", "groups": [ "f5b16084cd9850e90b4c45d2", "34b3eb2100e356c8ca284a92", "f458c0d51bf5728c31575e30" ], "created": "1942-07-19T12:11:44.769Z", "created_by": "c185f651c88860b5f5e63d2d", "last_updated": "1977-02-16T16:27:37.477Z", "last_updated_by": "a721456cab01c7e9bac99a26" }, { "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": "bce3c8bc-fb4c-b021-6a25-d64accc64b65", "groups": [ "8052af40c494830a7b9358f3", "115a40657a88ecceb98cee49", "8687662fcc5ce1e06dc8edec" ], "created": "2004-04-02T13:32:03.676Z", "created_by": "0f3e3b313d8e8e3902cd337f", "last_updated": "1990-05-30T11:37:03.74Z", "last_updated_by": "f578ac8370cd166463c3926c" } ]
{ "title": "data", "type": "array", "items": { "$ref": "formDocument" } }