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": "name", "exclude": "_id,description", "in": "in irure", "not-in": "ea exercitation fugiat Lorem Duis", "equals": "non esse commodo eu cupidatat", "contains": "nisi dolore dolore velit consectetur", "starts-with": "sunt irure deserunt tempor", "ends-with": "do" } }
{ "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": [ "adipisicing eu pariatur ex tempor", "aute qui quis", "exercitation quis pariatur non" ], "members": [], "_id": "4Cbc738bA7e6e08D5C8Dd9cD", "description": "exercitation Duis in consectetur nisi", "gbacWrite": [ "enim laborum incididunt in", "sunt dolor exercitation culpa et" ], "version": 1 }, { "name": "test", "gbacRead": [ "est fugiat", "ullamco eu", "ad pariatur minim Lorem labore", "ipsum voluptate", "et labore Duis proident" ], "members": [], "_id": "b00ad18F04CBBDAAfAC208c3", "description": "non", "gbacWrite": [ "Duis officia" ], "version": 1 }, { "name": "test", "gbacRead": [ "fugiat qui in", "tempor", "adipisicing aliqua enim", "commodo voluptate quis in", "anim est nulla culpa sed" ], "members": [], "_id": "6a1983a44e40dDDad519db60", "description": "in irure pariatur aliquip", "gbacWrite": [ "in qui", "reprehenderit" ], "version": 1 }, { "name": "test", "gbacRead": [ "ex fugiat", "laboris culpa velit non officia", "et", "ullamco consectetur cillum sunt eu", "veniam minim" ], "members": [], "_id": "4dcB4500DbDa0ceD5d30864c", "description": "sunt qui ea officia", "gbacWrite": [ "elit velit labore exercitation anim", "sunt", "pariatur commodo" ], "version": 1 }, { "name": "test", "gbacRead": [ "cupidatat consequat", "velit irure ea in proident", "occaecat laborum eiusmod", "anim ipsum" ], "members": [], "_id": "b128c7Cf0F1addFAE3D6B769", "description": "ea voluptate mollit", "gbacWrite": [ "ut aliqua elit" ], "version": 1 } ], "total": 76916951, "start": -25639315, "end": -27563409, "count": 1433766, "next": "aliqua qui aute adipisicing", "previous": "ut elit adipisicing" }
{ "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." } } }