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": 1, "skip": 0, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "exercitation ut labore", "not-in": "in elit Ut cupidatat tempor", "equals": "in eu velit", "contains": "laboris tempor consequat ipsum esse", "starts-with": "est enim nostrud", "ends-with": "consectetur sunt Ut aute" } }
{ "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": [ "ut non magna anim", "proident in" ], "members": [ { "path": [ "deserunt commodo laboris sint", "amet elit", "consectetur culpa Excepteur cupidatat", "in sed tempor consequat", "anim consectetur tempor in" ], "type": "folder" }, { "path": [ "nostrud", "sed dolor reprehenderit nisi", "ex incididunt et ut" ], "type": "folder" }, { "path": "dolor nostrud", "type": "component", "sourceCollection": "do", "ref": "eu anim" }, { "path": [ "eu proident nostrud dolore", "aliquip" ], "type": "folder" } ], "_id": "E10C5EDf5E2FAD4DC1F6a0DD", "description": "reprehenderit", "gbacWrite": [ "qui Duis nostrud labore", "cillum deserunt Lorem", "pariatur reprehenderit" ], "version": 1 }, { "name": "test", "gbacRead": [ "enim", "fugiat nisi", "labore", "esse in est", "velit" ], "members": [ { "path": [ "ea do tempor adipisicing" ], "type": "folder" }, { "path": [ "officia nulla", "enim eiusmod laboris", "irure in" ], "type": "folder" }, { "path": [ "culpa commodo minim ipsum", "est ad", "dolor ut in ipsum", "incididunt" ], "type": "folder" }, { "path": "et pariatur deserunt ea", "type": "component", "sourceCollection": "exercitation proident", "ref": "eu magna" } ], "_id": "c5C4af86Cec48358A98548a1", "description": "sunt ea", "gbacWrite": [ "ex nisi velit proident", "quis do Excepteur nulla ut" ], "version": 1 }, { "name": "test", "gbacRead": [ "dolore ipsum sit", "cillum elit Excepteur in in", "commodo ipsum cupidatat", "Duis sit sed", "magna" ], "members": [ { "path": [ "dolore aute veniam" ], "type": "folder" }, { "path": "commodo", "type": "component", "sourceCollection": "ea aliqua Lorem", "ref": "proident in in officia" }, { "path": "Duis laboris dolor ex sed", "type": "component", "sourceCollection": "velit aliquip veniam occaecat", "ref": "laborum consequat ad aute" } ], "_id": "Ac071cED08ba8fC2aDB3fD89", "description": "Duis officia dolor", "gbacWrite": [ "Duis nostrud in dolore", "commodo irure quis dolor voluptate", "pariatur" ], "version": 1 }, { "name": "test", "gbacRead": [ "cillum enim mollit do", "veniam", "fugiat officia", "Excepteur nisi dolor", "irure" ], "members": [ { "path": "enim quis occaecat veniam", "type": "component", "sourceCollection": "occaecat laborum in", "ref": "sed in velit" }, { "path": [ "consectetur", "commodo in", "id aute do", "exercitation" ], "type": "folder" } ], "_id": "64b556A6b59a9715d6916b4D", "description": "fugiat ea", "gbacWrite": [ "reprehenderit veniam consequat occaecat voluptate", "officia ex est" ], "version": 1 }, { "name": "test", "gbacRead": [ "voluptate magna sed sint pariatur", "veniam", "dolor eiusmod", "irure ea reprehenderit", "in" ], "members": [ { "path": [ "sunt laborum do", "est ex minim fugiat", "exercitation ipsum id elit", "reprehenderit Ut ad id do", "esse qui non laborum Duis" ], "type": "folder" }, { "path": "minim ipsum", "type": "component", "sourceCollection": "Excepteur eu", "ref": "incididunt occaecat adipisicing" }, { "path": [ "fugiat aliquip sit", "sint adipisicing" ], "type": "folder" }, { "path": "ad", "type": "component", "sourceCollection": "consectetur fugiat voluptate amet est", "ref": "consequat" }, { "path": [ "deserunt sed in do", "irure ad dolore dolor", "sit aliqua Lorem reprehenderit pariatur", "Duis reprehenderit non in" ], "type": "folder" } ], "_id": "54EeBdB9AfA2890e0D1cb07b", "description": "fugiat laborum sed officia", "gbacWrite": [ "elit esse", "dolor non laborum fugiat ea", "voluptate", "in aliqua sunt" ], "version": 1 } ], "total": 83694129, "start": 68739728, "end": 33669525, "count": 14306325, "next": "est officia aliquip deserunt elit", "previous": null }
{ "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" } ] } } }