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": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "sunt", "not-in": "id cupidatat officia eiusmod", "equals": "ut", "contains": "sint aute", "starts-with": "aliquip sint ea", "ends-with": "dolore dolore laborum eiusmod id" } }
{ "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": [ "ipsum dolore amet exercitation", "velit dolore qui", "Duis velit", "sed dolor dolore reprehenderit", "amet ex" ], "members": [ { "path": [ "in velit", "in esse", "magna", "ad ut", "aliqua" ], "type": "folder" } ], "_id": "9Aa2AcBdCDe5BC2Ae93933BB", "description": "sit nulla", "gbacWrite": [ "in minim dolor", "enim tempor veniam est", "quis magna exercitation Lorem nostrud" ], "version": 1 }, { "name": "test", "gbacRead": [ "adipisicing est", "officia exercitation reprehenderit ea", "quis" ], "members": [ { "path": [ "ipsum dolore amet dolore", "in id sint eiusmod" ], "type": "folder" }, { "path": "ea anim dolor id", "type": "component", "sourceCollection": "laborum elit eu cillum sed", "ref": "qui Ut aliquip do adipisicing" }, { "path": [ "enim in esse ut cupidatat", "ipsum laboris aliqua ex ad", "deserunt aute adipisicing do" ], "type": "folder" }, { "path": [ "magna mollit" ], "type": "folder" } ], "_id": "F053bDdcdD8CeAC7eDDeE1d5", "description": "tempor mollit occaecat cillum eu", "gbacWrite": [ "eiusmod labore in", "reprehenderit qui", "ut officia nulla", "eu anim consectetur" ], "version": 1 }, { "name": "test", "gbacRead": [ "nulla", "dolor veniam", "aliquip fugiat ullamco ut Ut" ], "members": [ { "path": [ "ipsum nulla velit officia fugiat", "aliqua ullamco consectetur voluptate", "sed reprehenderit aliqua", "in velit sint quis aliqua", "Lorem ea" ], "type": "folder" }, { "path": "Lorem eu non", "type": "component", "sourceCollection": "commodo sed Ut sit nulla", "ref": "reprehenderit dolore" } ], "_id": "1C333EFB6cdd2A5CAfd7f3Ff", "description": "irure cupidatat", "gbacWrite": [ "dolore fugiat" ], "version": 1 } ], "total": 98507707, "start": -12456269, "end": 13497463, "count": 48073446, "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" } ] } } }