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": "description", "exclude": "_id,description", "in": "ex ea", "not-in": "qui ipsum tempor magna do", "equals": "dolor deserunt", "contains": "aliquip deserunt et", "starts-with": "ullamco voluptate est magna", "ends-with": "ut exercitation occaecat nisi adipisicing" } }
{ "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": [ "laboris enim commodo nostrud fugiat", "aliqua commodo labore aliquip reprehenderit", "aliquip dolor consectetur magna" ], "members": [], "_id": "Cedfd25e75CeeaDd35a8c3CF", "description": "ad in fugiat non esse", "gbacWrite": [ "velit cillum ad", "ullamco laborum incididunt", "culpa mollit esse" ], "version": 1 }, { "name": "test", "gbacRead": [ "nostrud ex", "fugiat quis", "labore Duis Lorem", "officia mollit veniam", "non" ], "members": [], "_id": "82eCa971C41DD59Ecb5d8Bcd", "description": "incididunt in Duis magna", "gbacWrite": [ "proident enim non fugiat elit", "exercitation", "incididunt laboris" ], "version": 1 }, { "name": "test", "gbacRead": [ "tempor deserunt nulla officia laborum", "minim nostrud sed dolor", "ut aliquip consectetur incididunt Duis", "Duis aliquip", "nulla qui ipsum deserunt Ut" ], "members": [], "_id": "b2db5755883aa3B45d61649B", "description": "nulla", "gbacWrite": [ "consectetur nulla ex elit in", "deserunt nulla ad", "minim dolor ad cillum" ], "version": 1 }, { "name": "test", "gbacRead": [ "sint", "nisi Ut eu magna" ], "members": [], "_id": "CBbfF5b5F0Fe026DAb4fF5e3", "description": "dolore in exercitation laborum", "gbacWrite": [ "commodo esse", "dolor anim" ], "version": 1 }, { "name": "test", "gbacRead": [ "Duis", "aliqua Duis irure mollit", "cillum" ], "members": [], "_id": "6E9ae4BEAAF2C086436B73a0", "description": "sint consectetur", "gbacWrite": [ "consectetur", "cillum sit anim ut commodo", "eiusmod", "Ut exercitation", "dolore minim eu" ], "version": 1 } ], "total": -47815927, "start": -4389338, "end": -57406449, "count": 82642244, "next": "qui", "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." } } }