Summary
Gets a page of component group documents.
Description
Gets a page of component group documents.
Route
GET /automation-studio/component-groups
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryParameters | object | yes | Parameters for filtering, paginating, projecting, and sorting component group documents. |
{ "queryParameters": { "limit": 10, "skip": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": "ipsum est esse", "not-in": "ipsum", "equals": "dolor Duis minim", "contains": "fugiat occaecat adipisicing nostrud", "starts-with": "reprehenderit dolor Lorem aute ad", "ends-with": "dolor eu veniam tempor" } }
{ "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
Name | Type | Description |
---|---|---|
result | object | Results for the given search parameters. |
{ "items": [ { "name": "test", "gbacRead": [ "magna aliqua", "labore" ], "members": [ { "path": "laborum", "type": "component", "sourceCollection": "aliquip", "ref": "nisi eiusmod" }, { "path": "deserunt in esse", "type": "component", "sourceCollection": "id aliqua ullamco", "ref": "laborum cupidatat veniam" }, { "path": "in anim aute", "type": "component", "sourceCollection": "commodo dolore et deserunt", "ref": "nulla voluptate labore enim" }, { "path": [ "ea adipisicing ut ut" ], "type": "folder" } ], "_id": "be90F1CfdC70DFE3247B8f48", "description": "amet", "gbacWrite": [ "magna", "in ipsum dolor qui amet" ], "version": 1 }, { "name": "test", "gbacRead": [ "proident", "ut non", "nisi aliqua dolor", "do Lorem" ], "members": [ { "path": "incididunt culpa ut et voluptate", "type": "component", "sourceCollection": "voluptate labore", "ref": "esse ullamco et" }, { "path": "ipsum", "type": "component", "sourceCollection": "dolor", "ref": "sit consectetur dolor" }, { "path": "est cillum reprehenderit eiusmod", "type": "component", "sourceCollection": "laboris sunt ullamco sit", "ref": "aliquip irure qui anim culpa" } ], "_id": "F710b37eBb0087cB580acAC6", "description": "deserunt sint Ut fugiat", "gbacWrite": [ "ex" ], "version": 1 }, { "name": "test", "gbacRead": [ "laborum consequat", "Excepteur dolor", "qui commodo dolore eu mollit", "exercitation anim do ut sunt" ], "members": [ { "path": "dolore", "type": "component", "sourceCollection": "dolor nisi consectetur ex Excepteur", "ref": "laborum tempor sit consectetur ad" }, { "path": [ "eu nisi est", "nulla aliqua culpa" ], "type": "folder" }, { "path": [ "dolore dolor esse consectetur", "Lorem", "adipisicing", "sint fugiat sit" ], "type": "folder" }, { "path": "magna non ut dolore cillum", "type": "component", "sourceCollection": "elit non", "ref": "aliquip" } ], "_id": "adf516Dd7E224e875a46F1BC", "description": "in amet reprehenderit dolor", "gbacWrite": [ "id" ], "version": 1 }, { "name": "test", "gbacRead": [ "qui Duis proident voluptate Lorem", "cupidatat sit elit" ], "members": [ { "path": [ "est", "nostrud laborum" ], "type": "folder" }, { "path": "ut", "type": "component", "sourceCollection": "deserunt ex qui dolor cillum", "ref": "officia" }, { "path": "ullamco", "type": "component", "sourceCollection": "fugiat do labore", "ref": "Lorem tempor reprehenderit" } ], "_id": "437ff637b59C468Fe0055c7c", "description": "nostrud dolor reprehenderit aliquip enim", "gbacWrite": [ "pariatur sunt do voluptate", "velit", "nostrud Lorem ex elit cillum", "laboris in", "irure in est" ], "version": 1 }, { "name": "test", "gbacRead": [ "ea elit eu magna" ], "members": [ { "path": "exercitation", "type": "component", "sourceCollection": "officia Ut magna", "ref": "Duis minim in qui" }, { "path": "nostrud adipisicing labore ut enim", "type": "component", "sourceCollection": "fugiat", "ref": "sit veniam reprehenderit" } ], "_id": "0d8ccf4E3f73f4DA141dfC1A", "description": "reprehenderit dolor", "gbacWrite": [ "culpa cillum commodo laborum ut", "laborum ea dolore sed", "Duis ea", "ipsum cupidatat" ], "version": 1 } ], "total": 92092284, "start": -27914324, "end": 96717231, "count": -34971708, "next": null, "previous": "adipisicing incididunt" }
{ "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" } ] } } }