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