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": "name", "exclude": "_id", "in": "in irure id minim", "not-in": "anim nostrud esse labore in", "equals": "ut", "contains": "qui Lorem laborum sed", "starts-with": "sed cillum deserunt ex", "ends-with": "dolor laboris" } }
{ "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": [ "sint" ], "members": [ { "path": "quis", "type": "component", "sourceCollection": "qui dolore elit ut aliqua", "ref": "ad ullamco dolor ipsum deserunt" }, { "path": [ "quis in" ], "type": "folder" }, { "path": "deserunt", "type": "component", "sourceCollection": "mollit qui Ut", "ref": "voluptate in" }, { "path": "laboris ut dolor", "type": "component", "sourceCollection": "ullamco fugiat Lorem esse", "ref": "officia exercitation ad dolore" } ], "_id": "BAaFABDDA1A7DACe444F3bCa", "description": "ullamco consectetur sed minim velit", "gbacWrite": [ "dolor pariatur aliquip enim" ], "version": 1 }, { "name": "test", "gbacRead": [ "laborum", "irure est", "nulla nostrud in dolore laboris", "reprehenderit incididunt non dolor", "ea Ut" ], "members": [ { "path": "laboris enim", "type": "component", "sourceCollection": "eu sed esse laborum", "ref": "dolor fugiat nisi tempor" }, { "path": [ "amet" ], "type": "folder" }, { "path": "Excepteur sed velit laborum eiusmod", "type": "component", "sourceCollection": "dolore labore", "ref": "labore culpa eu" }, { "path": [ "proident magna", "Excepteur deserunt", "enim ut minim ad eu", "officia eu ut tempor incididunt" ], "type": "folder" } ], "_id": "c1CDEB9F2daD175F63625F6D", "description": "consectetur", "gbacWrite": [ "cillum tempor aliquip", "elit ex incididunt proident eu", "commodo", "incididunt laboris voluptate sit cillum" ], "version": 1 }, { "name": "test", "gbacRead": [ "reprehenderit", "id labore" ], "members": [ { "path": "pariatur tempor sint", "type": "component", "sourceCollection": "qui non", "ref": "dolor" }, { "path": "do minim in proident", "type": "component", "sourceCollection": "magna ea sed consectetur", "ref": "Duis cillum" }, { "path": "ut sunt enim amet", "type": "component", "sourceCollection": "sit occaecat culpa irure", "ref": "ipsum ex ut anim" }, { "path": "exercitation incididunt est culpa elit", "type": "component", "sourceCollection": "deserunt minim voluptate et Lorem", "ref": "dolor nulla do esse nostrud" }, { "path": "eu dolore", "type": "component", "sourceCollection": "Lorem dolore", "ref": "mollit" } ], "_id": "0131107b2F51f2C6a69A0f4d", "description": "mollit do", "gbacWrite": [ "incididunt consequat elit", "aliquip qui", "labore", "ut in cillum elit", "non" ], "version": 1 }, { "name": "test", "gbacRead": [ "in incididunt enim", "laborum do", "in nulla irure exercitation", "ad" ], "members": [ { "path": "qui pariatur", "type": "component", "sourceCollection": "dolore eiusmod", "ref": "aliqua nisi sed consectetur" }, { "path": [ "anim minim nostrud ut aliqua", "ullamco ipsum officia", "aliquip consectetur nisi dolore", "elit ipsum", "incididunt occaecat quis irure Duis" ], "type": "folder" }, { "path": [ "ut tempor sint sunt do", "nulla ipsum ea", "magna Ut voluptate", "fugiat non" ], "type": "folder" }, { "path": "anim mollit", "type": "component", "sourceCollection": "do ad", "ref": "id aliqua" } ], "_id": "2Fd9e15F2CbE2F77140478A6", "description": "sunt", "gbacWrite": [ "minim", "quis do Excepteur eu magna", "fugiat", "non in dolor sit", "eiusmod anim sed ex consequat" ], "version": 1 } ], "total": 74488503, "start": -19971142, "end": -8180924, "count": -69914822, "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" } ] } } }