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