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": "description", "exclude": "_id", "in": "sint non sed deserunt", "not-in": "anim sit dolor eiusmod", "equals": "irure adipisicing ex sint incididunt", "contains": "ipsum velit", "starts-with": "reprehenderit labore sint cillum cupidatat", "ends-with": "nulla officia anim amet" } }
{ "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": [ "tempor amet" ], "members": [], "_id": "9dFCFF2Fa7Bf50485Ac12d8D", "description": "est sit dolor veniam esse", "gbacWrite": [ "pariatur nisi", "tempor sed sit magna deserunt", "laboris" ], "version": 1 }, { "name": "test", "gbacRead": [ "anim deserunt", "esse", "nulla minim esse reprehenderit" ], "members": [], "_id": "ab4b0C444ecfbBBE1d52029a", "description": "proident ea in", "gbacWrite": [ "commodo Ut", "nulla deserunt irure voluptate nostrud", "magna", "veniam id", "in officia minim consectetur" ], "version": 1 }, { "name": "test", "gbacRead": [ "commodo", "reprehenderit minim" ], "members": [], "_id": "3bD7f53F15e9644d1b89e78A", "description": "Ut ex nostrud", "gbacWrite": [ "quis dolor ullamco est ex", "cillum labore in", "eiusmod", "eiusmod", "ex sit sed magna sunt" ], "version": 1 }, { "name": "test", "gbacRead": [ "incididunt eiusmod velit sint", "in culpa", "irure Excepteur consequat eiusmod nisi", "mollit tempor ut", "proident officia reprehenderit" ], "members": [], "_id": "70eA13d61B0B615be818BDD7", "description": "Lorem non irure", "gbacWrite": [ "nostrud est", "esse aute magna ipsum", "tempor sit esse ut Duis" ], "version": 1 }, { "name": "test", "gbacRead": [ "ut in ad esse anim", "ex amet Excepteur irure", "sed ipsum reprehenderit", "laboris dolor", "cillum" ], "members": [], "_id": "9eBa2B170Dc24fD97AB81fb5", "description": "est", "gbacWrite": [ "laboris est aliquip cupidatat fugiat" ], "version": 1 } ], "total": 56474803, "start": -58049206, "end": -28234340, "count": 79587740, "next": "cillum", "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": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }