{"type":"api","title":"Represents network devices associated with the groupUuid","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/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.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/GROUPING/grouping-service-overview.md"}},"openapi":"3.0.1","servers":[{"url":"http://localhost:8080/v1/grouping","description":"Generated server url"}]},"spec":{"tags":["Devices"],"summary":"Represents network devices associated with the groupUuid","description":"To effectively utilize this API endpoint, it is essential to incorporate both the 'start' and 'end' query parameters within your request.For instance, appending ?start=0&end=30 to your query will yield results from the starting index of 0 to the ending index of 30.","operationId":"getGroupDevices","parameters":[{"name":"groupUuid","in":"path","description":"UUID of the group whose associated devices are to be retrieved.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the devices associated with the group UUID.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of the operation result, indicating success, partial success, or error.","default":"Success","enum":["Success","Partial","Error"]},"group":{"type":"object","properties":{"uuid":{"maxLength":255,"minLength":0,"type":"string","description":"Unique identifier for the group, if available."},"name":{"maxLength":255,"minLength":0,"type":"string","description":"Name of the group."},"description":{"maxLength":255,"minLength":0,"type":"string","description":"Description of the group."},"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":{"maxLength":255,"minLength":0,"type":"string","description":"Classifier associated with the group."},"referenceUuid":{"maxLength":255,"minLength":0,"type":"string","description":"Reference UUID linked to the group, if applicable."},"children":{"maxItems":100000,"minItems":0,"type":"array","description":"List of child groups under this group.","items":{"$ref":"#/components/schemas/GroupDTO","$$ref":"#/components/schemas/GroupDTO"}},"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","description":"Number of child groups.","format":"int32"}},"description":"Data Transfer Object representing a group, including its properties and relationships.","$$ref":"#/components/schemas/GroupDTO"},"rule":{"required":["classifier"],"type":"object","properties":{"uuid":{"maxLength":255,"minLength":0,"type":"string","description":"Unique identifier for the rule, if available."},"classifier":{"maxLength":255,"minLength":0,"type":"string","description":"Classifier type for the rule.","enum":["LocationDevices","UserDefinedDevices","UserDefinedPorts"]},"conditions":{"type":"string","description":"Refer rule/conditions API for supported conditions properties and operators","format":"Stringify json of Java class"},"targetGroupUuid":{"maxLength":255,"minLength":0,"type":"string","description":"UUID of the target group associated with the rule, if applicable."}},"description":"Data Transfer Object representing a rule, including its attributes and conditions.","$$ref":"#/components/schemas/RuleDTO"},"error":{"type":"string","description":"Error message, if any, associated with the result."},"details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details related to the result, stored as key-value pairs."},"description":"Additional details related to the result, stored as key-value pairs."},"devices":{"type":"array","description":"Collection of DeviceDTO objects representing the devices involved in the operation.","items":{"required":["uuid"],"type":"object","properties":{"uuid":{"maxLength":255,"minLength":0,"type":"string","description":"Unique identifier for the device. This field is required."},"attributes":{"type":"object","additionalProperties":{"type":"object","description":"Map of attributes associated with the device, with a maximum of 100 entries."},"description":"Map of attributes associated with the device, with a maximum of 100 entries."}},"description":"Data Transfer Object representing a device, including its unique identifier and attributes.","$$ref":"#/components/schemas/DeviceDTO"}},"total":{"type":"integer","description":"Total number of devices included in the result.","format":"int32"}},"description":"Data Transfer Object representing the result of device-related operations, extending ResultDTO to include device details and total count.","$$ref":"#/components/schemas/DeviceResultDTO"},"example":{"status":"Success","devices":[{"uuid":"d4f18380-dd49-469d-97c7-857ea51f74a6","attributes":{"product_family":"Routers","node_ip":"0.0.0.0","software_type":"","description":"","delete":false,"hostname":"","product_type":"Cisco ASR 9006 Router","contact":"","last_update":1741773113,"product_series":"Cisco ASR 9000 Series Aggregation Services Routers","location":"","software_version":"","reachability":"CONN_STATE_REACHABLE","discoveryType":"Static"}}],"total":1}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"__originalOperationId":"getGroupDevices","method":"get","path":"/device/{groupUuid}"}}