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": "description", "exclude": "_id,description", "in": "in sed", "not-in": "eiusmod", "equals": "Lorem magna", "contains": "sint ipsum", "starts-with": "nisi laboris magna", "ends-with": "id proident sunt nostrud cillum" } }
{ "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": [ "cillum", "id esse cillum do amet", "ut exercitation et laboris", "non sunt ea", "sint" ], "members": [ { "path": [ "sed pariatur velit", "aliqua", "esse minim voluptate" ], "type": "folder" }, { "path": [ "in in", "est sunt ut", "qui elit Ut quis" ], "type": "folder" }, { "path": "aute deserunt dolore fugiat esse", "type": "component", "sourceCollection": "nulla do elit proident culpa", "ref": "esse sunt ex officia et" }, { "path": [ "quis", "commodo qui proident nulla ullamco", "fugiat voluptate velit sit ad" ], "type": "folder" } ], "_id": "8A6F9771084AD3FCb9a6Fb19", "description": "ea nulla incididunt", "gbacWrite": [ "laboris Excepteur incididunt" ], "version": 1 }, { "name": "test", "gbacRead": [ "cupidatat ad sunt consequat ut", "laboris", "nisi", "nulla sunt aliqua do ea", "sit quis dolor tempor" ], "members": [ { "path": "sunt irure", "type": "component", "sourceCollection": "dolor ut laborum ad sed", "ref": "officia in est in" }, { "path": "tempor deserunt dolor Lorem voluptate", "type": "component", "sourceCollection": "Duis elit ad enim", "ref": "sed" }, { "path": [ "labore aliqua qui voluptate", "ad esse" ], "type": "folder" }, { "path": [ "proident officia fugiat deserunt esse", "do ea laboris deserunt est", "reprehenderit ipsum fugiat elit cupidatat", "id deserunt velit" ], "type": "folder" } ], "_id": "c7d7Cf9C25F14a0F999CDc77", "description": "nostrud sed amet sit dolor", "gbacWrite": [ "cillum irure est velit", "do quis nostrud dolore", "aliquip Duis nostrud consequat", "laborum laboris" ], "version": 1 }, { "name": "test", "gbacRead": [ "veniam officia amet exercitation", "ut elit cupidatat nostrud nisi", "est amet do ex", "Lorem tempor occaecat laboris ullamco" ], "members": [ { "path": [ "mollit ea ullamco" ], "type": "folder" }, { "path": "dolore dolore ullamco", "type": "component", "sourceCollection": "minim Lorem magna pariatur consequat", "ref": "nisi" }, { "path": "ullamco quis minim", "type": "component", "sourceCollection": "labore qui in", "ref": "commodo" }, { "path": [ "ipsum" ], "type": "folder" } ], "_id": "22C44C3AfCF59aDCBB9114eB", "description": "aliquip in irure ut Duis", "gbacWrite": [ "est fugiat adipisicing incididunt", "laboris est Duis officia ullamco", "deserunt proident", "irure", "dolor cillum ut labore" ], "version": 1 }, { "name": "test", "gbacRead": [ "consectetur nisi sit" ], "members": [ { "path": [ "ipsum id", "laboris dolore id Excepteur", "ea id do qui mollit" ], "type": "folder" }, { "path": "adipisicing Duis", "type": "component", "sourceCollection": "cillum", "ref": "aliqua Excepteur ullamco esse" }, { "path": [ "laboris ad et consectetur" ], "type": "folder" }, { "path": [ "tempor esse", "in aliquip minim laboris nulla", "ut" ], "type": "folder" }, { "path": "aliquip ex", "type": "component", "sourceCollection": "aliqua sunt nulla labore nostrud", "ref": "ad proident dolor Ut dolor" } ], "_id": "b8A93DBAfb10c8F30AC56E0C", "description": "aute exercitation dolore dolore consectetur", "gbacWrite": [ "tempor reprehenderit Duis eu", "et", "ea", "reprehenderit in ad", "adipisicing culpa reprehenderit deserunt" ], "version": 1 }, { "name": "test", "gbacRead": [ "Excepteur" ], "members": [ { "path": "magna in", "type": "component", "sourceCollection": "dolor fugiat velit culpa", "ref": "do cillum anim Duis amet" }, { "path": [ "voluptate ut", "incididunt anim", "non cillum", "deserunt aute laborum" ], "type": "folder" }, { "path": [ "elit do adipisicing aute", "in non amet occaecat" ], "type": "folder" } ], "_id": "B406EA23FAdDC20070F08b4A", "description": "consequat incididunt dolor exercitation", "gbacWrite": [ "fugiat sed cupidatat dolor irure" ], "version": 1 } ], "total": -9500154, "start": -93240918, "end": -24632738, "count": -52620189, "next": "tempor dolor Lorem dolore", "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" } ] } } }