Parameters for filtering, paginating, projecting, and sorting component group documents.
Copied to Clipboard
{
"queryParameters": {
"limit": 25,
"skip": 0,
"order": 1,
"sort": "name",
"include": "name",
"exclude": "_id,description",
"in": "consequat enim",
"not-in": "ipsum sit velit dolore magna",
"equals": "minim ut magna adipisicing",
"contains": "eiusmod est non",
"starts-with": "fugiat",
"ends-with": "occaecat do in officia"
}
}
Copied to Clipboard
{
"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": [
"ex ut"
],
"members": [
{
"path": "exercitation",
"type": "component",
"sourceCollection": "aute qui dolore",
"ref": "officia eu pariatur mollit"
},
{
"path": "ut sit labore eu deserunt",
"type": "component",
"sourceCollection": "reprehenderit Excepteur non adipisicing",
"ref": "esse deserunt qui dolore sed"
},
{
"path": "minim enim est dolor",
"type": "component",
"sourceCollection": "reprehenderit tempor ex commodo velit",
"ref": "aliqua magna qui"
},
{
"path": "dolor officia id aliquip",
"type": "component",
"sourceCollection": "commodo adipisicing velit esse",
"ref": "est"
}
],
"_id": "A41d7b3fa89BEC5d7705B350",
"description": "id",
"gbacWrite": [
"Ut do commodo veniam",
"Ut Lorem proident",
"velit Lorem nulla ipsum",
"in occaecat anim"
],
"version": 1
}
],
"total": -47092523,
"start": -76681728,
"end": 25068068,
"count": -43820573,
"next": null,
"previous": "exercitation aute commodo enim cupidatat"
}
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": {
"description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"previous": {
"description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}