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": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": "deserunt anim voluptate laborum officia", "not-in": "proident ex adipisicing", "equals": "Ut consequat irure cupidatat quis", "contains": "do ipsum Lorem Ut", "starts-with": "fugiat do", "ends-with": "eiusmod" } }
{ "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": [ "Excepteur sint et consectetur" ], "members": [ { "path": [ "in", "ullamco ea", "nostrud tempor amet", "nostrud adipisicing eiusmod", "magna eu laboris" ], "type": "folder" }, { "path": "in do sint pariatur", "type": "component", "sourceCollection": "dolore proident Ut occaecat", "ref": "occaecat exercitation in mollit dolore" } ], "_id": "a3E7ed4bD42D3FC15d17f017", "description": "mollit consequat officia", "gbacWrite": [ "esse nostrud id sunt", "consequat anim", "ex aliquip", "aliquip", "anim qui pariatur non" ], "version": 1 }, { "name": "test", "gbacRead": [ "sit reprehenderit nulla in dolor", "ipsum id", "magna in" ], "members": [ { "path": "ullamco", "type": "component", "sourceCollection": "magna amet", "ref": "adipisicing" }, { "path": "mollit Duis", "type": "component", "sourceCollection": "sunt ullamco Ut aute", "ref": "sit" }, { "path": "ad nisi ea", "type": "component", "sourceCollection": "proident anim", "ref": "exercitation eu sunt sed fugiat" }, { "path": "consectetur cupidatat mollit cillum", "type": "component", "sourceCollection": "dolore consectetur voluptate", "ref": "ea Ut" }, { "path": [ "fugiat", "do officia mollit", "pariatur", "aliquip" ], "type": "folder" } ], "_id": "De3dDaAD8e10db4DFAd3eE3c", "description": "id ut qui elit laborum", "gbacWrite": [ "labore", "aute officia adipisicing proident in", "minim nisi dolor ea Ut", "do fugiat", "ullamco eu dolore amet" ], "version": 1 } ], "total": 77826963, "start": -9992626, "end": -3907536, "count": -14063488, "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" } ] } } }