Get services for node/link/alarm uid - Cisco Optical Network Controller 25.1.x API

{"type":"api","title":"Get services for node/link/alarm uid","meta":{"id":"/apps/pubhub/media/conc-2511/d77fe2fa1c66c5533550637c8fa49491e06b8c79/77098a86-496d-3923-960f-448e29c77e05","info":{"title":"ONC 3.1 API","version":"1.0.0-25.1.1","description":"Swagger documentation for CONC UI APIs","contact":{"name":"CONC UI API Support","url":"https://www.cisco.com","email":"support@cisco.com"},"license":{"name":"cisco.com","url":"cisco.com"}},"security":[],"tags":[{"name":"alarms","description":"Operations related to alarm management"},{"name":"alienImport","description":"Operations for importing alien data"},{"name":"health","description":"Operations related to Health check"},{"name":"highAvailability","description":"Operations for managing high availability"},{"name":"inventory","description":"Operations related to inventory management"},{"name":"links","description":"Operations for managing network links"},{"name":"logs","description":"Operations for managing system logs"},{"name":"nodes","description":"Operations for managing nodes"},{"name":"pmHistory","description":"Operations for managing performance monitoring history"},{"name":"serviceManager","description":"Operations for managing services"},{"name":"swimu","description":"Operations for managing software upgrades and backups"},{"name":"topology","description":"Operations for managing topology"}],"x-parser-conf":{"overview":{"markdownPath":"reference/2431/ui.md"},"serverConfig":"full","enableAuthEditing":true,"httpBasic":{"username":"api-user","password":"encrypted-password@123"}},"openapi":"3.0.0","securitySchemes":{"BearerAuth":{"description":"bearerAuthDetails","type":"http","scheme":"bearer","bearerFormat":"JWT"},"oAuthSample":{"description":"SecurityOAuth","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://api.example.com/oauth2/authorize","scopes":{"read_alarms":"read alarms in your account","write_alarms":"read alarms in your account","write":"write pmHistory","read":"read pmHistory"}}}}}},"spec":{"operationId":"getAffectedServicesList","tags":["serviceManager"],"description":"Get affected services list by node/link/alarm uid.","summary":"Get services for node/link/alarm uid","parameters":[{"in":"query","description":"type","name":"type","required":true,"schema":{"type":"string"}},{"in":"query","description":"uid","name":"uid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"description":"Response for fetching all services","type":"array","items":{"description":"Array of service list items","type":"object","properties":{"UID":{"description":"Unique identifier of the service","type":"string"},"serviceName":{"description":"Name of the service","type":"string","nullable":true},"label":{"description":"Label of the service","type":"string","nullable":true},"portRate":{"description":"Port rate of the service","type":"string","nullable":true},"distPlaneLifeCycleState":{"description":"Distribution plane lifecycle state","type":"string","nullable":true},"restorationState":{"description":"Restoration state of the service","type":"string","nullable":true},"restorationType":{"description":"Type of restoration","type":"string","nullable":true},"controlPlane":{"description":"Control plane information","type":"string","nullable":true},"tag":{"description":"Tags associated with the service","type":"array","nullable":true,"items":{"type":"string"}},"type":{"description":"Type of the service","type":"string","nullable":true},"protectionProfile":{"description":"Protection profile of the service","type":"string","nullable":true},"carrierDetails":{"description":"Carrier details of the service","type":"array","nullable":true,"items":{"description":"Response for carrier details","type":"object","properties":{"carrierUID":{"description":"Unique identifier of the carrier","type":"string","nullable":true},"frequency":{"description":"Frequency of the carrier","type":"number","nullable":true},"bandwidth":{"description":"Bandwidth of the carrier","type":"string","nullable":true},"operationalState":{"description":"Operational state of the carrier","type":"string","nullable":true},"adminState":{"description":"Administrative state of the carrier","type":"string","nullable":true},"lifecycleState":{"description":"Lifecycle state of the carrier","type":"string","nullable":true},"endPointA":{"description":"Endpoint A details of the carrier","type":"object","nullable":true,"items":{"description":"Response for endpoint details","type":"object","properties":{"deviceName":{"description":"Name of the device","type":"string","nullable":true},"portLabel":{"description":"Label of the port","type":"string","nullable":true},"portType":{"description":"Type of the port","type":"string","nullable":true}},"$$ref":"#/components/schemas/endpointsResponse"}},"endPointB":{"description":"Endpoint B details of the carrier","type":"object","nullable":true,"items":{"description":"Response for endpoint details","type":"object","properties":{"deviceName":{"description":"Name of the device","type":"string","nullable":true},"portLabel":{"description":"Label of the port","type":"string","nullable":true},"portType":{"description":"Type of the port","type":"string","nullable":true}},"$$ref":"#/components/schemas/endpointsResponse"}}},"$$ref":"#/components/schemas/carrierDetailsResponse"}},"operationalState":{"description":"Operational state of the service","type":"string","nullable":true},"adminState":{"description":"Administrative state of the service","type":"string","nullable":true},"lifecycleState":{"description":"Lifecycle state of the service","type":"string","nullable":true},"discoveryDate":{"description":"Discovery date of the service","type":"string","nullable":true},"errorMsg":{"description":"Error message associated with the service","type":"string","nullable":true},"innerServices":{"description":"Inner services associated with the service","type":"array","nullable":true,"items":{"description":"Response for inner service details","type":"object","properties":{"UID":{"description":"Unique identifier of the inner service","type":"string","nullable":true},"serviceName":{"description":"Name of the inner service","type":"string","nullable":true},"label":{"description":"Label of the inner service","type":"string","nullable":true},"tag":{"description":"Tags associated with the inner service","type":"array","items":{"type":"string"},"nullable":true},"type":{"description":"Type of the inner service","type":"string","nullable":true},"protectionProfile":{"description":"Protection profile of the inner service","type":"string","nullable":true},"portRate":{"description":"Port rate of the inner service","type":"string","nullable":true},"carrierDetails":{"description":"Carrier details of the inner service","type":"array","items":{"description":"Response for carrier details","type":"object","properties":{"carrierUID":{"description":"Unique identifier of the carrier","type":"string","nullable":true},"frequency":{"description":"Frequency of the carrier","type":"number","nullable":true},"bandwidth":{"description":"Bandwidth of the carrier","type":"string","nullable":true},"operationalState":{"description":"Operational state of the carrier","type":"string","nullable":true},"adminState":{"description":"Administrative state of the carrier","type":"string","nullable":true},"lifecycleState":{"description":"Lifecycle state of the carrier","type":"string","nullable":true},"endPointA":{"description":"Endpoint A details of the carrier","type":"object","nullable":true,"items":{"description":"Response for endpoint details","type":"object","properties":{"deviceName":{"description":"Name of the device","type":"string","nullable":true},"portLabel":{"description":"Label of the port","type":"string","nullable":true},"portType":{"description":"Type of the port","type":"string","nullable":true}},"$$ref":"#/components/schemas/endpointsResponse"}},"endPointB":{"description":"Endpoint B details of the carrier","type":"object","nullable":true,"items":{"description":"Response for endpoint details","type":"object","properties":{"deviceName":{"description":"Name of the device","type":"string","nullable":true},"portLabel":{"description":"Label of the port","type":"string","nullable":true},"portType":{"description":"Type of the port","type":"string","nullable":true}},"$$ref":"#/components/schemas/endpointsResponse"}}},"$$ref":"#/components/schemas/carrierDetailsResponse"},"nullable":true},"operationalState":{"description":"Operational state of the inner service","type":"string","nullable":true},"adminState":{"description":"Administrative state of the inner service","type":"string","nullable":true},"lifecycleState":{"description":"Lifecycle state of the inner service","type":"string","nullable":true},"distPlaneLifeCycleState":{"description":"Distribution plane lifecycle state of the inner service","type":"string","nullable":true},"restorationState":{"description":"Restoration state of the inner service","type":"string","nullable":true},"restorationType":{"description":"Type of restoration for the inner service","type":"string","nullable":true},"controlPlane":{"description":"Control plane information for the inner service","type":"string","nullable":true},"discoveryDate":{"description":"Discovery date of the inner service","type":"string","nullable":true},"errorMsg":{"description":"Error message associated with the inner service","type":"string","nullable":true},"innerServices":{"description":"Inner services associated with the inner service","type":"array","items":{"$ref":"#/components/schemas/InnerServiceResponse","$$ref":"#/components/schemas/InnerServiceResponse"},"nullable":true}},"$$ref":"#/components/schemas/InnerServiceResponse"}}},"$$ref":"#/components/schemas/ServiceListArrayResponse"},"$$ref":"#/components/schemas/FetchAllServicesResponse"},"example":{"affectedServices":[]}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"405":{"description":"Method Not Allowed"},"500":{"description":"Internal Server Error"}},"__originalOperationId":"getAffectedServicesList","security":[],"method":"get","path":"/api/service-manager/affectedservices"}}