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": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": "pariatur veniam", "not-in": "eu fugiat aute", "equals": "elit sit ea dolor reprehenderit", "contains": "aliquip in eu", "starts-with": "officia commodo", "ends-with": "Excepteur occaecat do eu magna" } }
{ "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": [ "consectetur dolore magna Ut", "ut Duis do minim veniam", "proident sed Excepteur qui ea", "amet dolore eu", "pariatur" ], "members": [ { "path": [ "sunt ut dolore", "Lorem eiusmod", "exercitation", "dolor incididunt ad Excepteur sunt" ], "type": "folder" } ], "_id": "Ea11ea56F6cD120dFdbb2061", "description": "et", "gbacWrite": [ "nulla nisi ut incididunt cupidatat" ], "version": 1 }, { "name": "test", "gbacRead": [ "aliquip eu culpa ullamco" ], "members": [ { "path": [ "sint non sed officia", "consectetur laborum Duis do", "sed ipsum reprehenderit non" ], "type": "folder" }, { "path": [ "aute est Ut magna" ], "type": "folder" } ], "_id": "c5ecc2De63cE65A8500F310c", "description": "non", "gbacWrite": [ "Ut", "aliquip dolore deserunt labore" ], "version": 1 }, { "name": "test", "gbacRead": [ "velit deserunt", "laboris mollit" ], "members": [ { "path": "amet eu adipisicing exercitation", "type": "component", "sourceCollection": "sint minim Lorem ex irure", "ref": "nulla voluptate" }, { "path": [ "ad Excepteur officia aute", "pariatur eiusmod", "fugiat sed non reprehenderit consequat", "elit Duis" ], "type": "folder" } ], "_id": "ddbf87f4cdbA176FE53ebc2E", "description": "aute anim aliquip consequat", "gbacWrite": [ "eiusmod ad", "aliqua Ut", "magna" ], "version": 1 }, { "name": "test", "gbacRead": [ "adipisicing", "sint elit", "laborum culpa minim", "est" ], "members": [ { "path": "occaecat consequat eu elit", "type": "component", "sourceCollection": "amet et", "ref": "anim laborum Lorem" } ], "_id": "ceCaB0c4e5Cf9d0Ea2be1aFb", "description": "in elit aliqua", "gbacWrite": [ "veniam", "id officia Excepteur ea dolor", "esse exercitation in sit", "anim nostrud ut magna" ], "version": 1 } ], "total": 60328808, "start": 41628946, "end": 99806894, "count": 38324189, "next": "id voluptate dolore", "previous": "aute officia" }
{ "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" } ] } } }