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