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": 1, "skip": 0, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": "irure et", "not-in": "minim ad elit qui labore", "equals": "in dolore fugiat ut aliqua", "contains": "anim", "starts-with": "esse", "ends-with": "ipsum proident ad" } }
{ "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": [ "mollit commodo", "id fugiat eiusmod", "Duis reprehenderit ut", "pariatur sint dolor sunt", "tempor cupidatat eiusmod et" ], "members": [ { "path": "aliquip sunt", "type": "component", "sourceCollection": "anim veniam", "ref": "est Excepteur culpa" } ], "_id": "dDf9d551AcCAF58B5F71245a", "description": "in eu culpa non ad", "gbacWrite": [ "voluptate eiusmod veniam minim", "enim" ], "version": 1 }, { "name": "test", "gbacRead": [ "aliquip nostrud dolore pariatur magna", "ullamco ipsum", "consequat qui veniam", "esse consectetur", "ex nisi pariatur" ], "members": [ { "path": [ "non", "sit consequat", "qui" ], "type": "folder" } ], "_id": "04C171DFF75Eb38a55e97090", "description": "culpa nostrud", "gbacWrite": [ "dolor aute anim", "fugiat Duis consequat" ], "version": 1 }, { "name": "test", "gbacRead": [ "in sunt nisi in", "labore exercitation ad voluptate Duis" ], "members": [ { "path": [ "commodo" ], "type": "folder" }, { "path": [ "sint deserunt", "minim fugiat Excepteur aute labore", "esse" ], "type": "folder" } ], "_id": "95853BC4F2abdD6febC5E5AA", "description": "sint laborum elit Duis", "gbacWrite": [ "commodo cillum Ut consequat", "dolore amet ut officia fugiat", "non reprehenderit" ], "version": 1 }, { "name": "test", "gbacRead": [ "qui nulla cupidatat", "consequat aliqua pariatur ut commodo", "aliquip culpa dolore occaecat minim", "adipisicing anim eu tempor", "ea" ], "members": [ { "path": "fugiat labore sed officia", "type": "component", "sourceCollection": "sint", "ref": "adipisicing eu laborum sunt dolore" } ], "_id": "7CfD0e3fBB08EC106e0C1AD9", "description": "pariatur non", "gbacWrite": [ "culpa veniam aute ipsum enim", "adipisicing mollit" ], "version": 1 } ], "total": 51592880, "start": -6619123, "end": -27610078, "count": 50366054, "next": "ad laboris enim", "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" } ] } } }