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": 50, "order": 1, "sort": "name", "include": "name", "exclude": "description", "in": "nostrud sint veniam in", "not-in": "velit ad deserunt", "equals": "eiusmod ut", "contains": "ullamco exercitation enim in incididunt", "starts-with": "mollit", "ends-with": "dolore ut et" } }
{ "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": [ "velit", "proident sint reprehenderit voluptate" ], "members": [ { "path": [ "veniam eiusmod velit" ], "type": "folder" }, { "path": [ "velit mollit officia elit" ], "type": "folder" }, { "path": [ "tempor" ], "type": "folder" }, { "path": [ "Lorem laboris anim consectetur", "ullamco amet id aute tempor" ], "type": "folder" }, { "path": [ "nulla ullamco", "irure minim ullamco" ], "type": "folder" } ], "_id": "63bbA8CcF80B5eABccde5281", "description": "pariatur", "gbacWrite": [ "in sit id Lorem Excepteur", "nisi", "Excepteur", "reprehenderit voluptate culpa ullamco" ], "version": 1 }, { "name": "test", "gbacRead": [ "ex mollit veniam Ut", "esse labore ea cillum", "incididunt ut", "ad laboris eu ipsum ut" ], "members": [ { "path": [ "magna officia mollit reprehenderit", "pariatur sunt Lorem dolor", "enim tempor ea" ], "type": "folder" }, { "path": [ "minim proident" ], "type": "folder" }, { "path": [ "voluptate nisi exercitation", "ex dolore", "mollit ex reprehenderit consectetur", "commodo" ], "type": "folder" }, { "path": "sed veniam tempor", "type": "component", "sourceCollection": "ad in", "ref": "nulla velit veniam" } ], "_id": "77e8c80Ea7ade5fBB867b8bb", "description": "incididunt amet sunt", "gbacWrite": [ "ad", "quis", "dolore" ], "version": 1 }, { "name": "test", "gbacRead": [ "dolore magna" ], "members": [ { "path": "sunt qui", "type": "component", "sourceCollection": "culpa voluptate enim eu", "ref": "sit cillum deserunt ex" }, { "path": [ "qui in cupidatat fugiat", "deserunt qui aute laboris ut", "commodo labore", "anim labore", "dolor eiusmod anim in" ], "type": "folder" }, { "path": "anim ut elit eiusmod aliqua", "type": "component", "sourceCollection": "voluptate cupidatat esse", "ref": "dolor elit et consectetur" }, { "path": "nisi", "type": "component", "sourceCollection": "consectetur quis veniam nostrud", "ref": "ex amet" } ], "_id": "c18f330E2ff0aE1ee05FCBc0", "description": "aute dolore ad", "gbacWrite": [ "pariatur veniam deserunt", "tempor", "dolore aliqua magna consectetur" ], "version": 1 } ], "total": -28147942, "start": -61059329, "end": 30646725, "count": -13336897, "next": "Ut consectetur amet", "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" } ] } } }