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": 25, "skip": 10, "order": 1, "sort": "name", "include": "name", "exclude": "description", "in": "sint tempor aliqua anim Excepteur", "not-in": "dolor consequat Ut in", "equals": "dolor et dolore nisi tempor", "contains": "officia Excepteur cupidatat", "starts-with": "proident nostrud", "ends-with": "nostrud nisi officia" } }
{ "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": [ "irure et minim" ], "members": [ { "path": [ "ut", "ad velit incididunt in" ], "type": "folder" }, { "path": [ "ea laborum commodo", "irure aute", "est proident", "in anim in velit", "ex laboris adipisicing aliqua cillum" ], "type": "folder" } ], "_id": "a1b6c27EADF93ac7b1B79CbC", "description": "sint in", "gbacWrite": [ "Duis consequat et fugiat", "voluptate dolor eiusmod Lorem et", "in dolor eiusmod in", "tempor voluptate aliquip" ], "version": 1 }, { "name": "test", "gbacRead": [ "et incididunt", "anim minim sit exercitation enim" ], "members": [ { "path": "sit", "type": "component", "sourceCollection": "deserunt consequat commodo Duis tempor", "ref": "ad" }, { "path": "aliquip sunt nostrud pariatur", "type": "component", "sourceCollection": "magna aliqua consequat", "ref": "nulla qui fugiat" }, { "path": [ "fugiat minim", "cillum Duis dolor dolore", "ullamco consectetur", "dolore Excepteur", "ex magna" ], "type": "folder" }, { "path": [ "id", "ullamco eiusmod dolor" ], "type": "folder" }, { "path": [ "irure in est", "tempor ex ipsum ut nostrud" ], "type": "folder" } ], "_id": "F1be94AFfABDD71BCBF9cfF5", "description": "anim tempor", "gbacWrite": [ "proident do aute minim qui", "ullamco consequat culpa" ], "version": 1 }, { "name": "test", "gbacRead": [ "qui irure officia aliqua", "nisi Excepteur proident in", "enim magna id ullamco qui", "sunt dolor proident tempor" ], "members": [ { "path": [ "eu in commodo in", "consequat" ], "type": "folder" }, { "path": [ "tempor mollit ad", "aliquip", "consequat mollit dolore fugiat ullamco" ], "type": "folder" } ], "_id": "74D8eb0A2DFcAC15497eEAC8", "description": "aute cillum ex", "gbacWrite": [ "aute non culpa voluptate Excepteur", "nostrud sint officia proident ex", "fugiat sed" ], "version": 1 } ], "total": 46044351, "start": 57360855, "end": -11186480, "count": 87475070, "next": "officia enim consequat cillum", "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" } ] } } }