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