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