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