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