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": "a0962056-c95e-9e5d-43c6-be04c22ed671",
"groups": [
"3c2eda49b7a42f687ecaec3a",
"bd4f1adeb298dd374fec6390"
],
"created": "2017-12-19T11:08:44.388Z",
"created_by": "0b63164089821fae806a6337",
"last_updated": "2012-05-14T10:22:18.362Z",
"last_updated_by": "7d33230258fdaf499a72c890"
}
]
Copied to Clipboard
{
"title": "data",
"type": "array",
"items": {
"$ref": "formDocument"
}
}
