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": "est adipisicing qui in", "not-in": "Lorem", "equals": "culpa do laboris Duis exercitation", "contains": "consectetur cillum exercitation reprehenderit id", "starts-with": "velit nulla", "ends-with": "dolore exercitation Duis sunt velit" } }
{ "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": [ "velit pariatur culpa Ut aliqua", "Excepteur in", "dolore consectetur nisi", "ut" ], "members": [ { "path": [ "Excepteur consequat nulla sint" ], "type": "folder" } ], "_id": "a2C27744a9602Afe5feAf6b9", "description": "cupidatat proident labore", "gbacWrite": [ "commodo mollit deserunt" ], "version": 1 }, { "name": "test", "gbacRead": [ "Duis reprehenderit", "sed ex", "laborum dolore dolor", "enim Excepteur officia Ut" ], "members": [ { "path": "in eu cupidatat mollit", "type": "component", "sourceCollection": "Lorem ea aliquip", "ref": "aliquip occaecat Lorem magna" }, { "path": [ "Lorem do" ], "type": "folder" }, { "path": [ "sunt ut occaecat velit", "cupidatat Lorem consectetur sed in", "velit sint", "nisi est quis non" ], "type": "folder" } ], "_id": "7f8F3bAa8fC0143beC53392F", "description": "sed et ex eu consectetur", "gbacWrite": [ "quis", "dolore consequat laborum occaecat sed", "sit quis reprehenderit fugiat ex" ], "version": 1 }, { "name": "test", "gbacRead": [ "irure ullamco Ut", "mollit elit officia eu" ], "members": [ { "path": "ut aute tempor", "type": "component", "sourceCollection": "mollit ex et non", "ref": "aliquip Duis laborum quis ad" }, { "path": "ullamco labore", "type": "component", "sourceCollection": "Duis sint irure", "ref": "dolore amet" }, { "path": [ "qui fugiat", "velit et Duis cillum", "ut ullamco dolore" ], "type": "folder" } ], "_id": "4CeF8bE8c407dDBAEF00BF45", "description": "consequat ullamco eiusmod elit commodo", "gbacWrite": [ "elit dolor labore" ], "version": 1 }, { "name": "test", "gbacRead": [ "culpa tempor magna", "Ut", "in adipisicing" ], "members": [ { "path": [ "id", "Lorem qui cillum nisi", "anim", "eiusmod cupidatat qui" ], "type": "folder" }, { "path": "sit pariatur", "type": "component", "sourceCollection": "fugiat", "ref": "quis pariatur et est non" }, { "path": [ "nostrud laboris et", "culpa minim aliqua sint", "laboris deserunt", "aliquip laboris", "in ipsum" ], "type": "folder" } ], "_id": "a7d9eAe3aBfbdedae346b18B", "description": "nisi consequat occaecat cupidatat", "gbacWrite": [ "aute pariatur nisi dolore", "dolor irure laborum", "nisi officia sint veniam in" ], "version": 1 }, { "name": "test", "gbacRead": [ "officia est", "magna sint", "minim deserunt" ], "members": [ { "path": [ "laborum culpa tempor Duis", "ad non elit", "non officia ut", "consequat exercitation minim", "consectetur exercitation esse" ], "type": "folder" } ], "_id": "1E39Be8acdF9B1Af8888cdA8", "description": "irure dolor quis ad", "gbacWrite": [ "dolore nulla" ], "version": 1 } ], "total": 53760553, "start": -81195045, "end": -62242796, "count": -66831041, "next": null, "previous": "sed" }
{ "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" } ] } } }