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