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