Get the REP ring based on the ring id - Cisco Catalyst Center API 3.1.3

{"type":"api","title":"Get the REP ring based on the ring id","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-3-1-3/9b7bce247bccb0311419e593770ef07f9552d9e1/d41c7da7-f399-330a-bd19-886309e55849","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 3.1.3","version":"3.1.3"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.3","servers":[{"url":"/"}]},"spec":{"operationId":"getTheREPRingBasedOnTheRingId_","tags":["Industrial Configuration"],"summary":"Get the REP ring based on the ring id.","deprecated":false,"description":"This API returns REP ring for the given id (The id of configured REP ring can be retrieved using the API /dna/intent/api/v1/iot/repRings/query).","parameters":[{"name":"id","description":"Ring ID of configured REP ring can be fetched using the API `/dna/intent/api/v1/iot/repRings/query`.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"responses":{"200":{"description":"Response body contains the result data based on search criteria.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of REP ring."},"rootNetworkDeviceId":{"type":"string","description":"Network device ID of the root node in the REP ring."},"rootNeighbourNetworkDeviceIds":{"type":"array","items":{"type":"string"},"description":"List of network device IDs of the immediate neighboring ring members of the root node."},"status":{"type":"string","enum":["DISCOVERY_REQUEST_RECEIVED","DISCOVERY_REQUEST_ACCEPTED","REMAINING_PORT_CHANNEL_IN_PROGRESS","REP_CONVERSION_IN_PROGRESS","REP_CONVERSION_COMPLETED","REP_CONVERSION_FAILED","REP_RING_DELETE_REQUEST_RECEIVED","REP_RING_DELETION_INPROGRESS","REP_RING_DELETION_ABORTED","REP_RING_DELETED","REP_RING_DELETION_FAILED","REP_RING_DELETED_WITH_ERRS","DISCOVERY_REQUEST_COMPLETED"],"description":"Status of the REP ring."},"repSegmentId":{"type":"integer","description":"REP segment is a chain of ports connected to each other and configured with a segment ID."},"deploymentMode":{"type":"string","enum":["FABRIC","NON_FABRIC"],"description":"Deployment mode of the configured REP ring."},"ringName":{"type":"string","description":"Unique name of REP ring configured."},"ringMembers":{"type":"array","items":{"type":"object","properties":{"networkDeviceId":{"type":"string","description":"Network device ID of the REP ring member."},"nodeName":{"type":"string","description":"Name of the ring member."},"portName1":{"type":"string","description":"Interface name of the REP ring member."},"portName2":{"type":"string","description":"Interface name of the REP ring member."},"ringOrder":{"type":"integer","description":"Order of the REP ring member in the ring topology."}}},"description":"Ring members of the REP ring configured."}},"required":["id","rootNetworkDeviceId","rootNeighbourNetworkDeviceIds"]},"description":"Query REP ring response."},"version":{"type":"integer","description":"Version of the response."}},"required":["response","version"]},"description":"","$$ref":"#/components/schemas/getTheREPRingBasedOnTheRingIdResponse"}}}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"21b0-c89c-4aaa-9609","x-rapi-overview":"This API returns REP ring for the given id (The id of configured REP ring can be retrieved using the API /dna/intent/api/v1/iot/repRings/query).","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Industrial Configuration","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/network-orchestration/v3/iot/repRings/${id}","x-rapi-publicPath":"/dna/intent/api/v1/iot/repRings/${id}","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-deprecationMessage":"","x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getTheREPRingBasedOnTheRingId.","method":"get","path":"/dna/intent/api/v1/iot/repRings/{id}"}}