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" }, { "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": "cd653a9b-6a25-5e27-8ed0-66f180c75b24", "groups": [ "50af5df19b7b1f8ca90b2557" ], "created": "1960-12-08T17:43:27.616Z", "created_by": "451c13ff5a1f2aa2fb149f4f", "last_updated": "1957-07-28T18:10:34.901Z", "last_updated_by": "c525bc622599d34d79358162" }, { "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": "86b4d402-6f78-c647-4852-31ca10b1b2aa", "groups": [ "df2bd02352f6385696b03f6c", "0a6d2b4c4f5483b9f218e8a8" ], "created": "1997-08-24T07:13:38.38Z", "created_by": "30dd545453090719012e7455", "last_updated": "1971-10-31T00:58:48.759Z", "last_updated_by": "46a8f286653d1646e0086e0c" }, { "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": "8e72ccea-917d-1d85-590a-bdbbb183890d", "groups": [ "c464965d4e7200097d85e174", "6dfd471cff8e42cf828c794d", "007723b2d386d0d4be843d89", "a338c279d6802496464370c2", "3f2c65dc5fb8da7d3c1bd878" ], "created": "1954-12-30T00:37:32.91Z", "created_by": "378aabbc32801ae5c40bda0a", "last_updated": "1972-09-28T02:06:28.589Z", "last_updated_by": "93da052ce27d7027b90336e3" }, { "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": "4140d41e-2a39-274a-5fcf-16b94e980066", "groups": [ "eee883fbdd1f7b460c595773", "3389ccf516eaf3d410b794ec", "1af7f6ce18c9d2e945ba0755", "a8240efe0ff410a956f2f938" ], "created": "1977-11-14T14:29:14.5Z", "created_by": "ef2a145c61744bbe5a78a056", "last_updated": "1986-04-04T00:15:13.679Z", "last_updated_by": "b97af34323f0db71fd9f1c1b" } ]
{ "title": "data", "type": "array", "items": { "$ref": "formDocument" } }