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": 50, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": "veniam dolore pariatur", "not-in": "eu pariatur sed laboris commodo", "equals": "nisi incididunt cupidatat consectetur exercitation", "contains": "est consequat id mollit", "starts-with": "tempor Duis pariatur Lorem incididunt", "ends-with": "fugiat ex ullamco enim 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": [ "fugiat" ], "members": [], "_id": "9a045d4c7ddE05FAd96e60cD", "description": "incididunt tempor labore velit", "gbacWrite": [ "ullamco dolor Lorem labore nulla", "velit aliquip ullamco", "id aute dolor officia", "nulla est tempor reprehenderit irure" ], "version": 1 }, { "name": "test", "gbacRead": [ "nisi nostrud proident", "veniam", "reprehenderit consequat ut", "veniam", "officia esse sed labore" ], "members": [], "_id": "38EBaB47D3dB90eA8efCfd2d", "description": "ex culpa", "gbacWrite": [ "ea fugiat", "velit ullamco dolore fugiat nostrud", "tempor" ], "version": 1 }, { "name": "test", "gbacRead": [ "cillum nulla enim do Excepteur", "exercitation aute", "dolore esse Excepteur ullamco" ], "members": [], "_id": "67DebA7E8BDbAaf45BA18DC3", "description": "officia cillum laborum dolor sint", "gbacWrite": [ "aute Ut laborum in sed", "sunt commodo", "enim incididunt minim adipisicing Ut", "id", "ut voluptate" ], "version": 1 }, { "name": "test", "gbacRead": [ "in", "sit labore in", "Lorem est sit cillum", "irure sed Excepteur id adipisicing" ], "members": [], "_id": "2b2C9EBfb12DB049219300c3", "description": "cupidatat est velit nulla", "gbacWrite": [ "consequat voluptate culpa", "Ut", "consequat veniam dolor elit", "proident ut cillum Lorem" ], "version": 1 }, { "name": "test", "gbacRead": [ "qui Ut dolore dolor", "dolor tempor veniam reprehenderit", "veniam sunt Lorem", "incididunt Ut", "eiusmod voluptate do in cillum" ], "members": [], "_id": "3A5DcE3e4D6eab2a3b51a6E0", "description": "veniam dolore sed laborum reprehenderit", "gbacWrite": [ "deserunt anim culpa nulla", "commodo", "in ipsum commodo" ], "version": 1 } ], "total": -43291715, "start": -94310627, "end": 83055518, "count": -44695297, "next": null, "previous": "occaecat exercitation veniam" }
{ "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." } } }