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