{
"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",
"gbacRead": [
"in ut occaecat",
"quis non",
"dolor id sunt esse"
],
"members": [],
"_id": "44EdD14fBda27F14167D2D4c",
"description": "Lorem enim occaecat sit pariatur",
"gbacWrite": [
"in ad",
"cupidatat",
"dolor aliqua nulla ipsum",
"in pariatur eiusmod",
"velit"
],
"version": 1
},
{
"name": "test",
"gbacRead": [
"quis laborum"
],
"members": [],
"_id": "91af52ee8b3df4B5Bfaf33FB",
"description": "in ut ad dolore",
"gbacWrite": [
"quis nulla culpa",
"pariatur",
"ad dolore",
"dolor commodo do incididunt",
"occaecat dolor est id"
],
"version": 1
},
{
"name": "test",
"gbacRead": [
"aute proident mollit",
"consectetur veniam ullamco",
"eu"
],
"members": [],
"_id": "dde537C111BdeFf05D96e6E5",
"description": "in aliqua sit dolore",
"gbacWrite": [
"incididunt cupidatat sit nisi et",
"labore ut",
"elit pariatur voluptate magna Ut",
"non anim nisi"
],
"version": 1
},
{
"name": "test",
"gbacRead": [
"proident",
"in laborum dolor"
],
"members": [],
"_id": "c9d10b0EbAc35DaD3dDAb6B1",
"description": "do elit",
"gbacWrite": [
"ex officia id qui magna",
"dolore sunt id fugiat elit",
"adipisicing elit",
"ut",
"mollit dolore"
],
"version": 1
}
],
"total": -33818367,
"start": 73866675,
"end": 93610831,
"count": -33806376,
"next": "magna proident dolor",
"previous": "sunt incididunt officia"
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "componentGroup"
}
},
"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."
}
}
}