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": 25, "skip": 50, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "tempor qui ut", "not-in": "id", "equals": "consectetur esse pariatur Excepteur", "contains": "ut mollit minim velit enim", "starts-with": "sit aliquip Lorem reprehenderit", "ends-with": "veniam dolore elit reprehenderit aliquip" } }
{ "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": [ "Lorem ullamco commodo", "reprehenderit anim amet et commodo", "minim ipsum do dolor laborum" ], "members": [ { "path": [ "nostrud occaecat id" ], "type": "folder" }, { "path": "ullamco", "type": "component", "sourceCollection": "deserunt anim sit do", "ref": "id tempor velit" }, { "path": "laboris ex eiusmod", "type": "component", "sourceCollection": "nostrud", "ref": "occaecat sit nulla" }, { "path": [ "ipsum sunt", "enim commodo qui laborum dolore", "nostrud Lorem" ], "type": "folder" } ], "_id": "0d7E23dF00C40cFFdCe9C1bf", "description": "minim non sint sed nostrud", "gbacWrite": [ "qui veniam nulla culpa aliquip", "proident", "eiusmod ad irure", "qui ut ex" ], "version": 1 }, { "name": "test", "gbacRead": [ "ad nostrud", "magna nostrud dolor", "mollit amet est Ut nulla", "id in esse nisi", "tempor velit nulla do" ], "members": [ { "path": "consectetur do", "type": "component", "sourceCollection": "velit elit laborum irure", "ref": "nisi" }, { "path": [ "Ut irure est", "ut adipisicing reprehenderit", "in enim nostrud" ], "type": "folder" }, { "path": "aute", "type": "component", "sourceCollection": "deserunt commodo", "ref": "Duis ut eiusmod in" }, { "path": [ "ut incididunt" ], "type": "folder" }, { "path": [ "aliquip sunt", "laboris et laborum dolor id", "laborum cupidatat", "commodo dolor occaecat" ], "type": "folder" } ], "_id": "91bAb68bA1c64b9fFD2ebd63", "description": "aliqua nisi sunt labore voluptate", "gbacWrite": [ "nostrud Duis pariatur occaecat", "sit magna irure commodo", "et laborum id Duis" ], "version": 1 }, { "name": "test", "gbacRead": [ "mollit", "deserunt in", "pariatur", "consequat ullamco exercitation officia Ut" ], "members": [ { "path": [ "consectetur proident esse", "ipsum", "dolor" ], "type": "folder" } ], "_id": "9dD822BC4AD4416d4CcB53Fc", "description": "officia", "gbacWrite": [ "dolor reprehenderit velit", "laborum" ], "version": 1 } ], "total": 46175886, "start": -43392625, "end": -86559274, "count": 8320850, "next": "ut anim", "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" } ] } } }