Summary
Searches resource models
Description
Searches resource models
Route
No Northbound API Available
Roles
admin
apiread
designer
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
searchOperator |
enum |
yes |
Allowed values are: [ equals, starts with, less than, less than or equals, greater than, greater than or equals ] |
searchProperty |
enum |
yes |
Allowed values are: [ _id, name, created, lastUpdated ] |
searchValue |
string |
yes |
- |
sortField |
enum |
yes |
Allowed values are: [ _id, name, created, lastUpdated ] |
sortOrder |
enum |
yes |
Allowed values are: [ asc, desc ] |
skip |
number |
yes |
- |
limit |
number |
yes |
- |
Copied to Clipboard
{
"searchOperator": "equals",
"searchProperty": "created",
"searchValue": "reprehenderit",
"sortField": "name",
"sortOrder": "asc",
"skip": 0,
"limit": 25
}
Copied to Clipboard
{
"type": "object",
"properties": {
"searchOperator": {
"title": "searchOperator",
"enum": [
"equals",
"starts with",
"less than",
"less than or equals",
"greater than",
"greater than or equals"
]
},
"searchProperty": {
"title": "searchProperty",
"enum": [
"_id",
"name",
"created",
"lastUpdated"
]
},
"searchValue": {
"title": "searchValue",
"type": "string"
},
"sortField": {
"title": "sortField",
"enum": [
"_id",
"name",
"created",
"lastUpdated"
],
"default": "name"
},
"sortOrder": {
"title": "sortOrder",
"enum": [
"asc",
"desc"
],
"default": "asc"
},
"skip": {
"title": "skip",
"type": "integer",
"minimum": 0,
"default": 0
},
"limit": {
"title": "limit",
"type": "integer",
"minimum": 1,
"default": 25
}
},
"required": [
"searchOperator",
"searchProperty",
"searchValue",
"sortField",
"sortOrder",
"skip",
"limit"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
searchResults |
object |
- |
Copied to Clipboard
{
"searchResults": true
}