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