Get Topology Group By Solution - Cisco Catalyst SD-WAN Manager API, Release 20.16

{"type":"api","title":"Get Topology Group By Solution","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Topology - Topology Group"],"description":"Get a Topology Group by Solution","operationId":"GetTopologyGroupBySolution","parameters":[{"name":"solution","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"required":["name","solution","state","version"],"type":"object","properties":{"activeStatus":{"type":"boolean"},"copyInfo":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the Group.","example":" group for west coast retail stores"},"devices":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"System generated unique identifier of the Group in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the Group. Must be unique.","example":"West coast retail stores"},"numberOfDevices":{"type":"integer","format":"int64"},"numberOfDevicesUpToDate":{"type":"integer","format":"int64"},"origin":{"type":"string"},"originInfo":{"type":"object","additionalProperties":{"type":"string"}},"profiles":{"type":"array","description":"List of devices UUIDs associated with this group","example":"West coast retail store devices","items":{"required":["name","solution","type"],"type":"object","properties":{"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the feature Profile.","example":"Profile file description"},"id":{"type":"string","description":"System generated unique identifier of the feature profile in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the feature Profile. Must be unique.","example":"system feature profile"},"profileParcelCount":{"type":"integer","description":"Number of Parcels attached with Feature Profile","format":"int64","readOnly":true},"solution":{"type":"string","description":"Solution of the feature Profile.","example":"sdwan"},"type":{"type":"string","description":"Type of the feature Profile.","example":"system"}},"description":"List of devices UUIDs associated with this group","example":"West coast retail store devices","$$ref":"#/components/schemas/FeatureProfile"}},"solution":{"type":"string","description":"Specify one of the device platform solution","example":"sdwan","enum":["mobility","sdwan","sd-routing","common","nfvirtual","service-insertion","cellulargateway"]},"source":{"type":"string","description":"Source of group","example":"retail_workflow"},"state":{"type":"string","description":" Group Deployment state","example":" Group Deployment state.Initial state Deployed "},"version":{"type":"integer","description":" Group Version Flag","format":"int64"}},"$$ref":"#/components/schemas/TopologyGroup"}},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-read","__originalOperationId":"GetTopologyGroupBySolution","method":"get","path":"/v1/topology-group"}}