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": 10, "skip": 50, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "dolore nostrud ipsum cillum et", "not-in": "officia enim", "equals": "eiusmod", "contains": "est magna", "starts-with": "enim velit et", "ends-with": "nulla" } }
{ "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": [ "nisi sunt aute Lorem", "quis", "fugiat cillum nulla in consectetur", "incididunt" ], "members": [ { "path": [ "sed occaecat do minim" ], "type": "folder" } ], "_id": "B2a860F0EB8bcD2d33d155a2", "description": "eu", "gbacWrite": [ "tempor enim ea laboris est", "proident minim laboris" ], "version": 1 }, { "name": "test", "gbacRead": [ "incididunt", "incididunt quis ipsum" ], "members": [ { "path": [ "ipsum eiusmod aute dolor Lorem", "occaecat", "in" ], "type": "folder" }, { "path": "ad", "type": "component", "sourceCollection": "culpa quis", "ref": "magna proident enim" }, { "path": [ "ullamco cupidatat", "aliquip culpa voluptate" ], "type": "folder" }, { "path": [ "dolor reprehenderit consequat" ], "type": "folder" } ], "_id": "deF6fE9c8E34D5Cbb6A6b0F5", "description": "enim qui do consequat", "gbacWrite": [ "exercitation mollit", "incididunt cillum occaecat", "veniam non occaecat mollit" ], "version": 1 }, { "name": "test", "gbacRead": [ "mollit proident id", "culpa esse in", "nostrud incididunt tempor exercitation ex" ], "members": [ { "path": [ "ullamco eiusmod elit Excepteur ad", "ex minim", "ipsum" ], "type": "folder" }, { "path": "consectetur voluptate", "type": "component", "sourceCollection": "labore voluptate", "ref": "eiusmod elit laboris Excepteur ut" }, { "path": "incididunt do non", "type": "component", "sourceCollection": "consequat quis dolore laboris", "ref": "anim consectetur" }, { "path": [ "enim Ut", "laboris" ], "type": "folder" } ], "_id": "Fe6DdA4ec9Ff358c3FFFEf90", "description": "Excepteur laborum", "gbacWrite": [ "labore", "cillum consequat sunt", "dolore", "in laborum" ], "version": 1 } ], "total": -28306006, "start": -85166037, "end": -72885547, "count": -97518640, "next": "reprehenderit in", "previous": "consequat est Ut commodo sit" }
{ "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" } ] } } }