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": 50, "skip": 0, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "in Lorem est pariatur", "not-in": "id incididunt fugiat elit quis", "equals": "esse minim eiusmod", "contains": "in ut consequat culpa", "starts-with": "consectetur magna incididunt", "ends-with": "cillum" } }
{ "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": [ "Lorem proident et deserunt", "enim pariatur", "labore in", "eu nulla", "dolore ipsum Ut fugiat deserunt" ], "members": [ { "path": "aute ullamco irure", "type": "component", "sourceCollection": "dolore", "ref": "laboris in Duis aliqua" }, { "path": "amet ex dolore cupidatat", "type": "component", "sourceCollection": "veniam ea minim voluptate", "ref": "culpa in" }, { "path": [ "tempor in dolore veniam nostrud", "nostrud laboris dolore amet labore", "irure veniam" ], "type": "folder" }, { "path": "fugiat", "type": "component", "sourceCollection": "aute sint quis elit eu", "ref": "et aliquip incididunt elit" }, { "path": [ "officia ullamco est nisi reprehenderit", "minim magna fugiat ea sed", "amet" ], "type": "folder" } ], "_id": "675fFE2FA2154E9A4E7CDE66", "description": "dolor et in", "gbacWrite": [ "quis labore" ], "version": 1 }, { "name": "test", "gbacRead": [ "sunt dolore ex", "aliquip sit nostrud", "anim", "sunt dolor elit aute" ], "members": [ { "path": "ex do Lorem", "type": "component", "sourceCollection": "amet", "ref": "deserunt dolor ut" }, { "path": "consectetur sed Excepteur et", "type": "component", "sourceCollection": "sint labore mollit eu dolor", "ref": "dolore laborum ut incididunt" }, { "path": "labore tempor", "type": "component", "sourceCollection": "esse minim dolore Ut ad", "ref": "aliqua dolor" }, { "path": "dolore sed", "type": "component", "sourceCollection": "minim", "ref": "aliqua aliquip ut in" } ], "_id": "d512D92e8b0BE1B83dCa7ace", "description": "aliquip nostrud", "gbacWrite": [ "aliquip amet est consectetur deserunt" ], "version": 1 } ], "total": 53596188, "start": -15973310, "end": -83575351, "count": 59943001, "next": "Ut", "previous": "voluptate" }
{ "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" } ] } } }