{"type":"api","title":"Get group hierarchies","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/7c48c18b-6630-3205-a601-ed557f355784","info":{"title":"APIs exposed by Grouping service","description":"Crosswork Grouping APIs allow the user to perform CRUD operations on grouping service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.2.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/GROUPING/grouping-service-overview.md"}},"openapi":"3.1.0","servers":[{"url":"http://localhost:8080/v1/grouping","description":"Generated server url"}]},"spec":{"tags":["Groups"],"summary":"Get group hierarchies","description":"Retrieves the hierarchies of specified groups using their UUIDs.","operationId":"getGroupsHierarchies","parameters":[{"name":"groupUuids","in":"path","description":"Comma-separated list of UUIDs identifying the groups whose hierarchies are to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"brief","in":"query","description":"Flag indicating whether to return a brief view of the group hierarchies. Default is false.","required":false,"schema":{"type":"boolean","default":false}},{"name":"direct","in":"query","description":"Use 'direct=true' to return direct subgroups only, or 'direct=false' to return the entire hierarchy","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successfully retrieved the group hierarchies.","content":{"application/json":{"schema":{"description":"Data Transfer Object representing a group, including its properties and relationships.","properties":{"uuid":{"type":"string","description":"Unique identifier for the group, if available.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name of the group.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description of the group.","maxLength":255,"minLength":0},"discoveryType":{"type":"string","description":"Type of discovery used for the group, if applicable.","enum":["Static","Dynamic","StaticSystem","Unknown"]},"nodeType":{"type":"string","description":"Node type of the group, if applicable.","enum":["Group","Member"]},"classifier":{"type":"string","description":"Classifier associated with the group.","maxLength":255,"minLength":0},"referenceUuid":{"type":"string","description":"Reference UUID linked to the group, if applicable.","maxLength":255,"minLength":0},"children":{"type":"array","description":"List of child groups under this group.","items":{"$ref":"#/components/schemas/GroupDTO","$$ref":"#/components/schemas/GroupDTO"},"maxItems":100000,"minItems":0},"parentUuid":{"type":"string","description":"UUID of the parent group, if applicable."},"parentName":{"type":"string","description":"Name of the parent group, if applicable."},"childrenCount":{"type":"integer","format":"int32","description":"Number of members."}},"$$ref":"#/components/schemas/GroupDTO"},"example":[{"uuid":"efc42cda-6ce5-4a47-ad96-d1e08a16b228","name":"Port Type","classifier":"PortType"},{"uuid":"9ac87805-69a9-403c-9fda-a0d892f362a8","name":"User Defined","classifier":"UserDefinedPorts"}]}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/groups/{groupUuids}"}}