Summary
Search Forms
Description
Search forms with options
Route
POST /formbuilder/forms/search
Roles
admin
apiread
operator
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
options |
object |
yes |
filter, startAt, maxResults, sort, fields, expand |
Copied to Clipboard
{
"options": {
"filter": {
"name": "form_example_1"
},
"startAt": 0,
"maxResults": 10,
"sort": {
"name": 1
},
"fields": [
"name",
"children",
"elements",
"createddBy",
"created",
"lastUpdatedBy",
"lastUpdated"
],
"expand": [
"createdBy",
"lastUpdatedBy"
]
}
}
Copied to Clipboard
{
"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
DetailsExampleSchema
Name |
Type |
Description |
data |
array |
Array of objects containing forms |
Copied to Clipboard
[
{
"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": "0b4716f2-5d6c-b983-19d7-f9e8d2b0f53a",
"groups": [
"a45082f490f1262167330e82",
"120b2c1fe995663f0809a767",
"1ebf618cc85c1e6a67dbd28c"
],
"created": "2003-12-16T08:45:38.468Z",
"created_by": "cdbd2e7622f4bd77ef3a6f19",
"last_updated": "1970-07-03T12:40:44.022Z",
"last_updated_by": "61096c24a617d8eb703e98a7"
},
{
"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": "a68a137d-1a7c-ea14-bd56-9d68b3798955",
"groups": [
"d1ecb7a7b8b9e845e44a95eb"
],
"created": "1945-10-08T10:48:09.201Z",
"created_by": "36b4f7b9545685a98802de28",
"last_updated": "2024-09-25T00:20:59.256Z",
"last_updated_by": "8c965aeee332b71941f20545"
}
]
Copied to Clipboard
{
"title": "data",
"type": "array",
"items": {
"$ref": "formDocument"
}
}