{
"type": "object",
"properties": {
"queryParameters": {
"title": "queryParameters",
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Number of results to return. Used for pagination.",
"default": 25,
"minimum": 0,
"examples": [
1,
10,
50
]
},
"skip": {
"type": "integer",
"description": "Number of results to skip. Used for pagination.",
"default": 0,
"minimum": 0,
"examples": [
1,
10,
50
]
},
"order": {
"type": "integer",
"description": "Sort direction, 1 for ascending and -1 for descending.",
"default": 1,
"enum": [
-1,
1
]
},
"sort": {
"type": "string",
"description": "Field to sort by",
"default": "name",
"enum": [
"name"
]
},
"include": {
"type": "string",
"description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.",
"examples": [
"name",
"description",
"name,description"
]
},
"exclude": {
"type": "string",
"description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.",
"examples": [
"_id",
"description",
"_id,description"
]
},
"in": {
"description": "Search for fields exactly matching one of the given list options",
"type": "string"
},
"not-in": {
"description": "Search for fields not exactly matching one of the given list options",
"type": "string"
},
"equals": {
"description": "Returns results where the specified fields exactly match the given match string(s).",
"type": "string"
},
"contains": {
"description": "Returns results where the specified fields contain the given match string(s).",
"type": "string"
},
"starts-with": {
"description": "Returns results where the specified fields start with the given match string(s).",
"type": "string"
},
"ends-with": {
"description": "Returns results where the specified fields end in the given match string(s).",
"type": "string"
}
}
}
},
"required": [
"queryParameters"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name
Type
Description
result
object
Results for the given search parameters.
Copied to Clipboard
{
"items": [
{
"name": "test",
"group": "Sample group",
"command": "show ip br",
"description": "description",
"template": "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record",
"data": "some sample text to match against",
"type": "test",
"_id": "592Dcb74b6E7Cbad2776cf3d",
"createdBy": "A71Db883B7DbcdEbCAeE1Ed2",
"created": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": "0Ceb629dd61c1e6cBfdaB5f9",
"lastUpdated": "2019-11-25T22:51:39.201Z",
"version": 1,
"tags": [
{
"_id": "FD2c151dDe32b1fC45eb0f1c",
"name": "dolor consequat sint",
"description": "A user-defined object to help group documents."
},
{
"_id": "DAfFA6adEbEcEddADcF9CDea",
"name": "dolore",
"description": "A user-defined object to help group documents."
},
{
"_id": "8afCD75fBDC0d961DF7e9f08",
"name": "in sunt amet",
"description": "A user-defined object to help group documents."
},
{
"_id": "cfcEBB316A8e5dd3be7abb4E",
"name": "ullamco velit",
"description": "A user-defined object to help group documents."
},
{
"_id": "8dFb74c11fDAEdd42f5BCaDE",
"name": "irure non aliqua id velit",
"description": "A user-defined object to help group documents."
}
]
}
],
"total": -27910236,
"start": -82848229,
"end": 78203397,
"count": 69616537,
"next": null,
"previous": null
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "template"
}
},
"total": {
"type": "integer",
"description": "Total number of documents matching the given query parameters."
},
"start": {
"type": "integer",
"description": "Search index of first document in the items array."
},
"end": {
"type": "integer",
"description": "Search index of the last document in the items array."
},
"count": {
"type": "integer",
"description": "Length of the items array."
},
"next": {
"type": [
"string",
"null"
],
"description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results."
},
"previous": {
"type": [
"string",
"null"
],
"description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results."
}
}
}