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": 10, "skip": 10, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": "deserunt", "not-in": "ut est culpa dolore officia", "equals": "Lorem consectetur ullamco", "contains": "sint quis", "starts-with": "veniam reprehenderit eiusmod consectetur", "ends-with": "pariatur incididunt tempor magna" } }
{ "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": [ "proident", "Lorem aute Excepteur commodo", "consectetur ut", "enim est ullamco Excepteur" ], "members": [ { "path": [ "irure minim", "amet magna eu", "mollit pariatur ex minim" ], "type": "folder" }, { "path": [ "nisi do sit" ], "type": "folder" }, { "path": [ "in" ], "type": "folder" }, { "path": [ "culpa deserunt", "culpa", "sed", "ea mollit aute", "voluptate anim" ], "type": "folder" }, { "path": "laboris dolor ullamco enim", "type": "component", "sourceCollection": "et", "ref": "do irure velit" } ], "_id": "dEE5aBf9cbBaD605be0Ae820", "description": "sint tempor laboris fugiat occaecat", "gbacWrite": [ "cillum ut irure" ], "version": 1 }, { "name": "test", "gbacRead": [ "mollit laborum pariatur ullamco", "ut", "sit magna ad", "qui" ], "members": [ { "path": [ "eiusmod", "velit voluptate nulla in", "ea elit incididunt Duis id", "Lorem consequat Ut", "labore sit dolor aliquip" ], "type": "folder" } ], "_id": "1458aDB52E2BD0a8939a3f4b", "description": "ipsum", "gbacWrite": [ "magna esse eiusmod", "sed", "deserunt magna qui dolore aliquip", "qui", "in id ex Duis mollit" ], "version": 1 }, { "name": "test", "gbacRead": [ "qui adipisicing laboris non", "elit laboris sed ea", "non elit Lorem" ], "members": [ { "path": "dolor aliquip nostrud nisi", "type": "component", "sourceCollection": "laborum", "ref": "laboris occaecat esse" }, { "path": "ut sed voluptate", "type": "component", "sourceCollection": "fugiat amet commodo", "ref": "dolor consectetur" }, { "path": [ "eu sed velit sint voluptate", "officia", "irure elit amet nostrud", "eu nisi laboris ut", "in" ], "type": "folder" } ], "_id": "6D18c6eEd5de71c6a56CF7fD", "description": "proident est", "gbacWrite": [ "sunt ut" ], "version": 1 } ], "total": 1141924, "start": -59208165, "end": -34863738, "count": 68238429, "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" } ] } } }