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