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": 10, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "eu nisi officia reprehenderit mollit", "not-in": "officia", "equals": "nisi cillum ut dolore", "contains": "ut quis proident", "starts-with": "ut dolore", "ends-with": "adipisicing eiusmod" } }
{ "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": [ "amet labore sit minim", "elit", "laborum commodo", "officia dolore", "labore nostrud quis cupidatat aute" ], "members": [ { "path": [ "in qui dolor eiusmod irure", "ut" ], "type": "folder" }, { "path": "in", "type": "component", "sourceCollection": "laboris aliquip nulla adipisicing", "ref": "culpa" } ], "_id": "6CA7748235104eea7fbB30CC", "description": "voluptate cillum cupidatat", "gbacWrite": [ "ut ut labore ea pariatur", "consectetur", "et minim", "amet minim" ], "version": 1 }, { "name": "test", "gbacRead": [ "Ut quis voluptate et minim", "amet nisi adipisicing", "proident Lorem dolore", "proident consectetur", "Lorem eiusmod incididunt elit nisi" ], "members": [ { "path": [ "in dolor ut" ], "type": "folder" } ], "_id": "e43D9BCBec4D613E4Aa57ade", "description": "dolor ea consectetur", "gbacWrite": [ "enim", "cillum in", "exercitation in elit nostrud", "veniam ut dolore Ut" ], "version": 1 }, { "name": "test", "gbacRead": [ "Duis do sunt", "tempor minim", "dolor magna ut et", "ea in nostrud tempor commodo", "velit sunt" ], "members": [ { "path": "mollit voluptate commodo sunt", "type": "component", "sourceCollection": "laborum", "ref": "in Excepteur occaecat" }, { "path": [ "ea occaecat nostrud", "ullamco commodo incididunt", "sit dolor occaecat do quis" ], "type": "folder" } ], "_id": "1BC63b2aD2b46743F75Ad0ee", "description": "esse dolore sit", "gbacWrite": [ "mollit adipisicing", "nostrud esse labore proident", "consectetur et", "commodo sit amet", "eiusmod deserunt anim laborum qui" ], "version": 1 }, { "name": "test", "gbacRead": [ "laboris", "culpa qui est amet occaecat" ], "members": [ { "path": [ "sint", "do est consequat", "sit reprehenderit", "in dolor tempor", "ut in" ], "type": "folder" }, { "path": [ "aute officia do mollit", "ipsum occaecat Ut Duis" ], "type": "folder" } ], "_id": "3BadbD6Fca715AD109C6Bbc2", "description": "cupidatat", "gbacWrite": [ "dolore nulla do esse", "id labore eu ut" ], "version": 1 } ], "total": 18368718, "start": -83196130, "end": -70415482, "count": 71857010, "next": null, "previous": "in dolor" }
{ "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" } ] } } }