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": 1, "skip": 1, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "sed consequat laborum Duis", "not-in": "incididunt sed nulla ad", "equals": "deserunt", "contains": "officia ex", "starts-with": "reprehenderit ut labore id pariatur", "ends-with": "dolor aute" } }
{ "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": [ "occaecat ut anim", "sit dolor est aute", "ut incididunt dolore", "amet esse proident occaecat mollit" ], "members": [ { "path": [ "laboris aute do reprehenderit", "dolore laborum", "consectetur occaecat dolore ex", "reprehenderit tempor consequat", "ipsum cupidatat" ], "type": "folder" }, { "path": "qui elit", "type": "component", "sourceCollection": "cillum esse aliquip mollit", "ref": "sit ex" }, { "path": [ "veniam commodo proident consectetur", "Excepteur enim cillum dolore" ], "type": "folder" }, { "path": "quis", "type": "component", "sourceCollection": "sint et dolor minim", "ref": "minim labore in" } ], "_id": "1304C4de47BfbeEf5AB1d7C6", "description": "reprehenderit qui sed ullamco eiusmod", "gbacWrite": [ "deserunt" ], "version": 1 }, { "name": "test", "gbacRead": [ "minim", "ut dolor", "in", "proident esse", "dolor sint voluptate tempor" ], "members": [ { "path": "labore irure sunt voluptate ea", "type": "component", "sourceCollection": "esse ad dolore in", "ref": "deserunt irure cupidatat" }, { "path": "Ut", "type": "component", "sourceCollection": "velit ut Ut", "ref": "elit Ut" } ], "_id": "9cb1D36981dEb6e0a74b9Cfa", "description": "culpa consectetur est", "gbacWrite": [ "anim", "ipsum deserunt Ut commodo anim", "sed adipisicing", "sint dolor" ], "version": 1 }, { "name": "test", "gbacRead": [ "Lorem labore" ], "members": [ { "path": "Lorem incididunt sit et", "type": "component", "sourceCollection": "ad incididunt in", "ref": "Excepteur" }, { "path": [ "anim aliqua" ], "type": "folder" }, { "path": "elit est sit", "type": "component", "sourceCollection": "Duis", "ref": "pariatur" }, { "path": [ "ex", "eu pariatur", "enim commodo", "aute sed", "qui sed Ut" ], "type": "folder" } ], "_id": "17ac23AB1658be70CDa4F712", "description": "non et", "gbacWrite": [ "eiusmod incididunt laborum id esse", "occaecat deserunt ut", "amet", "dolor nostrud", "cillum aute" ], "version": 1 } ], "total": -38780470, "start": 32108937, "end": -58547725, "count": -92504130, "next": null, "previous": "est elit" }
{ "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" } ] } } }