Summary
Searches resource instances
Description
Searches resource instances
Route
No Northbound API Available
Roles
admin
apiread
designer
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| searchOperator |
enum |
yes |
Allowed values are: [ equals, starts with ] - The operator to use for the search |
| searchProperty |
enum |
yes |
Allowed values are: [ _id, name, modelName, modelId, created, lastUpdated, createdBy, lastUpdatedBy ] - The instance property to search by |
| searchValue |
string |
yes |
The property value to use for the search |
| includeDeleted |
boolean |
yes |
If true, returns deleted instances |
| sortField |
enum |
yes |
Allowed values are: [ _id, name, modelId, created, createdBy, lastUpdated, lastUpdatedBy, lastAction.type ] - The instance property to sort by |
| sortOrder |
enum |
yes |
Allowed values are: [ asc, desc ] - The order to sort by |
| skip |
number |
yes |
The number of instances to skip |
| limit |
number |
yes |
The maximum number of instances to return |
Copied to Clipboard
{
"searchOperator": "equals",
"searchProperty": "name",
"searchValue": "officia laborum commodo enim",
"includeDeleted": false,
"sortField": "name",
"sortOrder": "asc",
"skip": 0,
"limit": 25
}
Copied to Clipboard
{
"type": "object",
"properties": {
"searchOperator": {
"title": "searchOperator",
"enum": [
"equals",
"starts with"
]
},
"searchProperty": {
"title": "searchProperty",
"default": "name",
"enum": [
"_id",
"name",
"modelName",
"modelId",
"created",
"lastUpdated",
"createdBy",
"lastUpdatedBy"
]
},
"searchValue": {
"title": "searchValue",
"type": "string"
},
"includeDeleted": {
"title": "includeDeleted",
"type": "boolean",
"default": false
},
"sortField": {
"title": "sortField",
"enum": [
"_id",
"name",
"modelId",
"created",
"createdBy",
"lastUpdated",
"lastUpdatedBy",
"lastAction.type"
],
"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",
"includeDeleted",
"sortField",
"sortOrder",
"skip",
"limit"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| searchResults |
object |
- |
Copied to Clipboard
{
"searchResults": true
}
