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": "name", "exclude": "_id,description", "in": "nostrud qui est non", "not-in": "laborum veniam", "equals": "occaecat", "contains": "magna cillum esse", "starts-with": "Excepteur id aliquip reprehenderit amet", "ends-with": "exercitation incididunt aute cupidatat voluptate" } }
{ "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": [ "amet ipsum cupidatat est" ], "members": [ { "path": [ "id et" ], "type": "folder" }, { "path": [ "dolore", "fugiat incididunt aliquip dolore aliqua", "quis" ], "type": "folder" }, { "path": "sint laboris ipsum reprehenderit Lorem", "type": "component", "sourceCollection": "Ut cupidatat", "ref": "cupidatat eiusmod irure Excepteur" }, { "path": [ "culpa consequat cupidatat", "Duis" ], "type": "folder" } ], "_id": "beDffEc0A7763b60F19ecb11", "description": "dolor sint", "gbacWrite": [ "voluptate", "magna laboris nostrud esse reprehenderit", "sunt aliqua et", "deserunt", "eiusmod amet ex nostrud" ], "version": 1 }, { "name": "test", "gbacRead": [ "exercitation laborum in", "id elit cillum aute eiusmod", "tempor mollit" ], "members": [ { "path": "in do consectetur", "type": "component", "sourceCollection": "nisi quis labore", "ref": "qui" } ], "_id": "C4781dfcEA0f4476bb0ff0a4", "description": "nulla", "gbacWrite": [ "Ut culpa", "quis commodo enim occaecat", "esse", "est" ], "version": 1 }, { "name": "test", "gbacRead": [ "sit exercitation" ], "members": [ { "path": "aliqua dolor laborum Duis", "type": "component", "sourceCollection": "sit reprehenderit mollit in", "ref": "laborum et officia" }, { "path": [ "consectetur Ut nulla" ], "type": "folder" }, { "path": "veniam et ullamco pariatur", "type": "component", "sourceCollection": "ipsum tempor et adipisicing aliqua", "ref": "est dolor exercitation" } ], "_id": "11071959aC5594CB29E1acE5", "description": "et deserunt", "gbacWrite": [ "dolore" ], "version": 1 }, { "name": "test", "gbacRead": [ "consectetur laboris sit in irure" ], "members": [ { "path": "ut magna laborum aute nulla", "type": "component", "sourceCollection": "dolore dolor culpa do in", "ref": "Ut sit ut veniam laboris" }, { "path": [ "do laborum", "adipisicing irure ut dolore aliquip" ], "type": "folder" } ], "_id": "4CEFFebb983a949dC1FbccE1", "description": "laborum velit", "gbacWrite": [ "ea non sed exercitation in", "ipsum culpa", "fugiat sint eu reprehenderit", "sint ex nisi deserunt", "ut Duis ex officia" ], "version": 1 } ], "total": -31685981, "start": 80087736, "end": -39153243, "count": -5383162, "next": null, "previous": "ipsum do aute pariatur cillum" }
{ "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" } ] } } }