DWDMChannel - Cisco Optical Network Planner (CONP) API - Cisco DevNet

{"type":"model","meta":{"id":"/apps/pubhub/media/conp-api/b9861fe2e1aca02803f44af045abe0e5033ce2e9/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"title":"Cisco Optical Network Planner API","description":"Cisco Optical Network Planner api documentation","contact":{},"license":{"name":"CONP-AE-License","url":"http://www.cisco.com"},"version":"24.3.1+2024.10.03"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"openapi":"3.0.1","securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Authentication Token"}}},"spec":{"required":["UID"],"type":"object","properties":{"entityType":{"type":"string","description":"Entity Type","example":"DWDMChannel"},"UID":{"type":"string","description":"UID","example":"0408733c-75ad-4d53-b725-d5787e9c1407"},"label":{"type":"string","description":"Label","example":"DWDMChannel1"},"type":{"type":"string","description":"Type","example":"200G-SD-FEC"},"wavelength":{"type":"number","format":"double","description":"Wavelength","example":10},"srcSite":{"type":"string","description":"Source Site","example":"7535dea2-3cd5-49a5-9a97-88581031c157"},"srcPort":{"type":"string","description":"Source Port","example":"2"},"dstSite":{"type":"string","description":"Destination Site","example":"60e10acc-18c9-44cc-bd41-85a06f3e79c4"},"dstPort":{"type":"string","description":"Destination Port","example":"2"},"bidirectional":{"type":"boolean","description":"True or False","example":false},"businessStatus":{"type":"string","description":"Business Status","example":"FUTURE"},"networkStatus":{"type":"string","description":"Network Status","example":"UNDISCOVERED"},"isActive":{"type":"boolean","description":"True or False","example":false},"protection":{"type":"string","description":"Protection Type","example":"Client1+1"},"colorless":{"type":"boolean","description":"Colorless","example":false},"contentionless":{"type":"boolean","description":"True or false","example":false},"omnidirectional":{"type":"boolean","description":"Omnidirectional","example":false},"hasRegen":{"type":"boolean","description":"Has Regen","example":false},"isRegenWave":{"type":"boolean","description":"Is Regen Wave","example":false},"regenType":{"type":"string","description":"Regen Type","example":"Yes"},"regens":{"type":"array","items":{"type":"string"},"description":"Regens","example":["u654rt-765ty-a9aabb77-4707-474a-ab5b"]},"routeConstraints":{"description":"Route Constraints","example":{"inclusions":["ba4b94bd-4a5d-4590-982f-bb9a2f23a2fa"],"exclusions":["gf94bd-4a5d-4590-982f-bb9a2f23a2fa"]},"type":"object","properties":{"pathForcing":{"description":"Path Forcing","type":"array","items":{"type":"string"},"example":["8279cee9-57f4-4cb5-a3f5-7028c"]},"exclusions":{"description":"Exclusions","type":"array","items":{"type":"string"},"example":["8279cee9-57f4-4cb5-a3f5-7028c"]},"inclusions":{"description":"Inclusions","type":"array","items":{"type":"string"},"example":["8279cee9-57f4-4cb5-a3f5-7028c"]}},"$$ref":"#/components/schemas/RouteConstraints"},"path":{"type":"array","items":{"type":"string"},"description":"Path","example":["464c165b-e18d-4dc9,464c165b-e-4dc9"]},"restoredPath":{"type":"array","items":{"type":"string"},"description":"Restored Path","example":["464c165b-e18d-4dc9,464c165b-e-4dc9"]},"restorationErrors":{"uniqueItems":true,"type":"array","items":{"type":"string"},"description":"Restoration Errors","example":["464c165b-e18d-4dc9,464c165b-e-4dc9"]},"unlocked":{"type":"array","items":{"type":"string"},"description":"Unlock Array","example":["this"]},"forced":{"type":"array","items":{"type":"string"},"description":"Forced Array","example":["3456778Gtytty"]},"opticalResults":{"description":"Optical Results","example":{"forward":{"totalLength":10.45,"osnrSOL":34.5,"statusOsnrMarginSOL":"R","osnrMarginEOL":-625.34,"statusOsnrMarginEOL":"R","rxPowerSOL":-7.99,"rxPowerMarginSOL":4.3,"statusRxPowerMarginSOL":"G"},"reverse":{"totalLength":10.45,"osnrSOL":34.5,"statusOsnrMarginSOL":"R","osnrMarginEOL":-625.34,"statusOsnrMarginEOL":"R","rxPowerSOL":-7.99,"rxPowerMarginSOL":4.3,"statusRxPowerMarginSOL":"G"}},"type":"object","properties":{"channelLabel":{"type":"string","description":"Channel Label","example":"channel-100"},"channelUid":{"type":"string","description":"Channel UID","example":"53664d73-7b4e-4fb4-9f5c-449825df5954"},"statusEOL":{"type":"string","description":"Status EOL","example":"EOL"},"forward":{"description":"Forward","example":{"totalLength":45,"osnrMarginSOL":5.6},"type":"object","properties":{"statusRxPowerMarginValuesSOL":{"description":"Status Rx Power Margin Values SOL","type":"array","items":{"type":"string"},"example":["4.5"]},"txAtten":{"description":"TX Atten","type":"string","example":"ATT-LC-5 5.0dB"},"solOverload":{"format":"double","description":"SOL Overload","type":"number","example":123.45},"multiChannelNLEXpmXtalk":{"format":"double","description":"Multi-Channel NLE XPM Xtalk","type":"number","example":123.45},"snleComponents":{"description":"SNLE Components","type":"string","example":"[ SC: 0.0], [ OSNR Penalty: 0.0 ]"},"source":{"description":"Source","type":"string","example":"Site2.A"},"statusValuesSE":{"description":"Status Values SE","type":"array","items":{"type":"string"},"example":["8.57"]},"statusOsnrMarginSOL":{"description":"Status OSNR Margin SOL","type":"string","example":"G"},"frequency":{"description":"Frequency","type":"string","example":"195.90000"},"gsnrEOL":{"format":"double","description":"GSNR EOL","type":"number","example":123.45},"statusRxPowerMarginValuesEOL":{"description":"Status RX Power Margin Values EOL","type":"array","items":{"type":"string"},"example":["2.68","1.85","1.01","0.17"]},"statusOverloadValuesEOL":{"description":"Status Overload Values EOL","type":"array","items":{"type":"string"},"example":["2.68","1.85","1.01","0.17"]},"osnrSOL":{"format":"double","description":"OSNR SOL","type":"number","example":123.45},"minGB":{"format":"double","description":"Min GB","type":"number","example":123.45},"rxPowerMarginValuesEOL":{"description":"Rx Power Margin Values EOL","type":"array","items":{"format":"double","type":"number"},"example":[123.45]},"filtering":{"format":"double","description":"Filtering","type":"number","example":123.45},"mnleComponents":{"description":"MNLE Components","type":"string","example":"[FWM:-Infinity], [ XPM: -Infinity], [ CM-48: -100.0], [ Opt-ByPass: 0.0]"},"wavelength":{"description":"Wavelength","type":"string","example":"345.45"},"statusMultiChannelNLE":{"description":"Status Multi-Channel NLE","type":"string","example":"G"},"statusRxPowerMarginEOL":{"description":"Status Rx Power Margin EOL","type":"string","example":"G"},"statusSOL":{"description":"Status SOL","type":"string","example":"G"},"logoData":{"description":"Logo Data","example":{"addOSNRAseAve":"100.0","dropOSNRAseAve":"100.0","addXT_NL_Ave":"0.0","dropXT_NL_Ave":"0.0"},"type":"object","properties":{"dropXT_NL_Ave":{"description":"xT_NL_Ave","type":"string","example":"A"},"addXT_NL_Ave":{"description":"xT_NL_Ave","type":"string","example":"A"},"addOSNRAseAve":{"description":"oSNRAseAve","type":"string","example":"A"},"totalXT_LIN":{"description":"Total XT LIN","type":"string","example":"A"},"dropOSNRAseAve":{"description":"oSNRAseAve","type":"string","example":"A"},"apcDomain":{"description":"APC Domain","type":"array","items":{"type":"object","properties":{"srcNode":{"type":"string","description":"Source node","example":"Site-2.A (BandC)"},"dstNode":{"type":"string","description":"Destination node","example":"Site-1.A (BandC)"},"oSNRAseAve":{"type":"string","description":"oSNRAseAve","example":"25.23038101196289"},"xT_NL_Ave":{"type":"string","description":"xT_NL_Ave","example":"-52.33454653884439"},"oSNR_EQ_AVE":{"type":"string","description":"oSNR_EQ_AVE","example":"25.23038101196289"},"fiberList":{"type":"array","description":"List of fibers","example":["Duct1","Duct2"],"items":{"type":"string","description":"List of fibers values","example":"Duct1"}},"baudRate":{"type":"number","format":"double","description":"Baud-rate value in bits per second","example":60.14}},"description":"ApcDomain object","$$ref":"#/components/schemas/ApcDomain"},"example":[{"srcNode":"Site-2.A (BandC)","dstNode":"Site-1.A (BandC)","oSNRAseAve":"25.23038101196289","xT_NL_Ave":"-52.33454653884439","oSNR_EQ_AVE":"25.221929291897645","fiberList":["Duct1"],"baudRate":0}]},"totalOSNR EQ":{"description":"Total OSNR EQ","type":"string","example":"23"}},"$$ref":"#/components/schemas/LogoData"},"statusValuesSOL":{"description":"Status Values SOL","type":"array","items":{"type":"string"},"example":["G"]},"statusEOL":{"description":"Status EOL","type":"string","example":"G"},"totalLength":{"format":"double","description":"Total Length","type":"number","example":123.45},"statusOverloadValuesSOL":{"description":"Status Overload Values SOL","type":"array","items":{"type":"string"},"example":["G"]},"rxPowerMarginValuesSOL":{"description":"RX Power Margin Values SOL","type":"array","items":{"format":"double","type":"number"},"example":[2.5]},"cdRobustness":{"description":"CD Robustness","type":"string","example":"59900"},"osnrVarianceEOL":{"format":"double","description":"OSNR Variance EOL","type":"number","example":123.45},"singleChannelNLEOsnrPenalty":{"format":"double","description":"Single Channel NLE OSNR Penalty","type":"number","example":123.45},"spectrum":{"format":"double","description":"Spectrum","type":"number","example":123.45},"statusRxPowerMarginSOL":{"description":"Status RX Power Margin SOL","type":"string","example":"G"},"statusFiltering":{"description":"Status Filtering","type":"string","example":"G"},"solOverloadValues":{"description":"SOL Overload Values","type":"array","items":{"format":"double","type":"number"},"example":[4.5]},"eolOverload":{"format":"double","description":"EOL Overload","type":"number","example":123.45},"statusValuesEOL":{"description":"Status Values EOL","type":"array","items":{"type":"string"},"example":["G","G","G","G"]},"statusOsnrMarginEOL":{"description":"Status OSNR Margin EOL","type":"string","example":"G"},"dstColorless":{"description":"Destination Colorless","type":"string","example":"Yes"},"bandType":{"description":"Band Type","type":"string","example":"CNAND"},"multiChannelNLECM48Xtalk":{"format":"double","description":"Multi Channel NLE CM48 Xtalk","type":"number","example":123.45},"suggestedRegLoc":{"description":"Suggested Regeneration Location","type":"string","example":"abc"},"linearOSNREOL":{"format":"double","description":"Linear OSNR EOL","type":"number","example":123.45},"statusTotalPMD":{"description":"Status Total PMD","type":"string","example":"G"},"srcTxType":{"description":"Source TX Type","type":"string","example":"NCS1004_QPSK_200G_27%SDFEC_69GBd,Default( CLASS: BO )"},"demandFeasibilityStatusEOL":{"description":"Demand Feasibility Status EOL","type":"string","example":"G"},"statusSingleChannelNLE":{"description":"Status Single Channel NLE","type":"string","example":"G"},"osnrMarginValuesEOL":{"description":"OSNR Margin Values EOL","type":"array","items":{"format":"double","type":"number"},"example":[3.4]},"destination":{"description":"Destination","type":"string","example":"Site-1.T"},"singleChannelNLEScPenalty":{"format":"double","description":"Single Channel NLE SC Penalty","type":"number","example":123.45},"dstTxType":{"description":"Dst Tx Type","type":"string","example":"NCS1004_QPSK_200G_27%SDFEC_69GBd,Default( CLASS: BO )"},"powerPenalties":{"description":"Power Penalties","type":"string","example":"[APC:0.6700][PDG_PDL:0.5099]"},"rxPowerMarginEOL":{"format":"double","description":"Rx Power Margin EOL","type":"number","example":123.45},"statusOsnrMarginValuesEOL":{"description":"Status OSNR Margin Values EOL","type":"array","items":{"type":"string"},"example":["G"]},"eolOverloadValues":{"description":"EOL Overload Values","type":"array","items":{"format":"double","type":"number"},"example":[3.4]},"encryption":{"description":"True or False","type":"string","example":"True"},"osnrMarginValuesSOL":{"description":"OSNR Margin Values SOL","type":"array","items":{"format":"double","type":"number"},"example":[3.4]},"statusOverloadSOL":{"description":"Status Overload SOL","type":"string","example":"G"},"multiChannelNLEFwmXtalk":{"format":"double","description":"Multi-Channel NLE FWM Xtalk","type":"number","example":123.45},"isOOBOConsidered":{"description":"Is OOBO Considered","type":"string","example":"NO"},"nonLinearOSNREOL":{"format":"double","description":"Non-Linear OSNR EOL","type":"number","example":123.45},"protect":{"description":"Protect","type":"string","example":"Client 1+1"},"statusSE":{"description":"Status SE","type":"string","example":"G"},"gsnrSOL":{"format":"double","description":"GSNR SOL","type":"number","example":123.45},"srcColorless":{"description":"Src Colorless","type":"string","example":"Yes"},"srcOmniDir":{"description":"Source Omni Directional","type":"string","example":"Yes"},"powerVarianceEOL":{"format":"double","description":"Power Variance EOL","type":"number","example":123.45},"totalCD":{"format":"double","description":"Total CD","type":"number","example":123.45},"osnrEOL":{"format":"double","description":"OSNR EOL","type":"number","example":123.45},"statusOverloadEOL":{"description":"Status Overload EOL","type":"string","example":"G"},"osnrMarginEOL":{"format":"double","description":"OSNR Margin EOL","type":"number","example":123.45},"rxPowerEOL":{"format":"double","description":"RX Power EOL","type":"number","example":123.45},"statusTotalCD":{"description":"Status Total CD","type":"string","example":"G"},"dstOmniDir":{"description":"Destination Omni Directional","type":"string","example":"Yes"},"statusOsnrMarginValuesSOL":{"description":"Status OSNR Margin Values SOL","type":"array","items":{"type":"string"},"example":["34"]},"berTarget":{"description":"BER Target","type":"string","example":"1.0E-12"},"rxAtten":{"description":"RX Atten","type":"string","example":"None"},"totalPMD":{"format":"double","description":"Total Pmd","type":"number","example":123.45},"osnrPenalties":{"description":"OSNR Penalties","type":"string","example":"None"},"PF":{"description":"PF","type":"string","example":"None"},"osnrMarginSOL":{"format":"double","description":"OSNR Margin SOL","type":"number","example":123.45},"multiChannelNLEOptByPassXtalk":{"format":"double","description":"Multi-Channel NLE Opt By Pass Xtalk","type":"number","example":123.45},"rxPowerSOL":{"format":"double","description":"RX Power SOL","type":"number","example":123.45},"rxPowerMarginSOL":{"format":"double","description":"RX Power Margin SOL","type":"number","example":123.45}},"$$ref":"#/components/schemas/L0OpticalResults"},"reverse":{"description":"Reverse","example":{"totalLength":45,"osnrMarginSOL":5.6},"type":"object","properties":{"statusRxPowerMarginValuesSOL":{"description":"Status Rx Power Margin Values SOL","type":"array","items":{"type":"string"},"example":["4.5"]},"txAtten":{"description":"TX Atten","type":"string","example":"ATT-LC-5 5.0dB"},"solOverload":{"format":"double","description":"SOL Overload","type":"number","example":123.45},"multiChannelNLEXpmXtalk":{"format":"double","description":"Multi-Channel NLE XPM Xtalk","type":"number","example":123.45},"snleComponents":{"description":"SNLE Components","type":"string","example":"[ SC: 0.0], [ OSNR Penalty: 0.0 ]"},"source":{"description":"Source","type":"string","example":"Site2.A"},"statusValuesSE":{"description":"Status Values SE","type":"array","items":{"type":"string"},"example":["8.57"]},"statusOsnrMarginSOL":{"description":"Status OSNR Margin SOL","type":"string","example":"G"},"frequency":{"description":"Frequency","type":"string","example":"195.90000"},"gsnrEOL":{"format":"double","description":"GSNR EOL","type":"number","example":123.45},"statusRxPowerMarginValuesEOL":{"description":"Status RX Power Margin Values EOL","type":"array","items":{"type":"string"},"example":["2.68","1.85","1.01","0.17"]},"statusOverloadValuesEOL":{"description":"Status Overload Values EOL","type":"array","items":{"type":"string"},"example":["2.68","1.85","1.01","0.17"]},"osnrSOL":{"format":"double","description":"OSNR SOL","type":"number","example":123.45},"minGB":{"format":"double","description":"Min GB","type":"number","example":123.45},"rxPowerMarginValuesEOL":{"description":"Rx Power Margin Values EOL","type":"array","items":{"format":"double","type":"number"},"example":[123.45]},"filtering":{"format":"double","description":"Filtering","type":"number","example":123.45},"mnleComponents":{"description":"MNLE Components","type":"string","example":"[FWM:-Infinity], [ XPM: -Infinity], [ CM-48: -100.0], [ Opt-ByPass: 0.0]"},"wavelength":{"description":"Wavelength","type":"string","example":"345.45"},"statusMultiChannelNLE":{"description":"Status Multi-Channel NLE","type":"string","example":"G"},"statusRxPowerMarginEOL":{"description":"Status Rx Power Margin EOL","type":"string","example":"G"},"statusSOL":{"description":"Status SOL","type":"string","example":"G"},"logoData":{"description":"Logo Data","example":{"addOSNRAseAve":"100.0","dropOSNRAseAve":"100.0","addXT_NL_Ave":"0.0","dropXT_NL_Ave":"0.0"},"type":"object","properties":{"dropXT_NL_Ave":{"description":"xT_NL_Ave","type":"string","example":"A"},"addXT_NL_Ave":{"description":"xT_NL_Ave","type":"string","example":"A"},"addOSNRAseAve":{"description":"oSNRAseAve","type":"string","example":"A"},"totalXT_LIN":{"description":"Total XT LIN","type":"string","example":"A"},"dropOSNRAseAve":{"description":"oSNRAseAve","type":"string","example":"A"},"apcDomain":{"description":"APC Domain","type":"array","items":{"type":"object","properties":{"srcNode":{"type":"string","description":"Source node","example":"Site-2.A (BandC)"},"dstNode":{"type":"string","description":"Destination node","example":"Site-1.A (BandC)"},"oSNRAseAve":{"type":"string","description":"oSNRAseAve","example":"25.23038101196289"},"xT_NL_Ave":{"type":"string","description":"xT_NL_Ave","example":"-52.33454653884439"},"oSNR_EQ_AVE":{"type":"string","description":"oSNR_EQ_AVE","example":"25.23038101196289"},"fiberList":{"type":"array","description":"List of fibers","example":["Duct1","Duct2"],"items":{"type":"string","description":"List of fibers values","example":"Duct1"}},"baudRate":{"type":"number","format":"double","description":"Baud-rate value in bits per second","example":60.14}},"description":"ApcDomain object","$$ref":"#/components/schemas/ApcDomain"},"example":[{"srcNode":"Site-2.A (BandC)","dstNode":"Site-1.A (BandC)","oSNRAseAve":"25.23038101196289","xT_NL_Ave":"-52.33454653884439","oSNR_EQ_AVE":"25.221929291897645","fiberList":["Duct1"],"baudRate":0}]},"totalOSNR EQ":{"description":"Total OSNR EQ","type":"string","example":"23"}},"$$ref":"#/components/schemas/LogoData"},"statusValuesSOL":{"description":"Status Values SOL","type":"array","items":{"type":"string"},"example":["G"]},"statusEOL":{"description":"Status EOL","type":"string","example":"G"},"totalLength":{"format":"double","description":"Total Length","type":"number","example":123.45},"statusOverloadValuesSOL":{"description":"Status Overload Values SOL","type":"array","items":{"type":"string"},"example":["G"]},"rxPowerMarginValuesSOL":{"description":"RX Power Margin Values SOL","type":"array","items":{"format":"double","type":"number"},"example":[2.5]},"cdRobustness":{"description":"CD Robustness","type":"string","example":"59900"},"osnrVarianceEOL":{"format":"double","description":"OSNR Variance EOL","type":"number","example":123.45},"singleChannelNLEOsnrPenalty":{"format":"double","description":"Single Channel NLE OSNR Penalty","type":"number","example":123.45},"spectrum":{"format":"double","description":"Spectrum","type":"number","example":123.45},"statusRxPowerMarginSOL":{"description":"Status RX Power Margin SOL","type":"string","example":"G"},"statusFiltering":{"description":"Status Filtering","type":"string","example":"G"},"solOverloadValues":{"description":"SOL Overload Values","type":"array","items":{"format":"double","type":"number"},"example":[4.5]},"eolOverload":{"format":"double","description":"EOL Overload","type":"number","example":123.45},"statusValuesEOL":{"description":"Status Values EOL","type":"array","items":{"type":"string"},"example":["G","G","G","G"]},"statusOsnrMarginEOL":{"description":"Status OSNR Margin EOL","type":"string","example":"G"},"dstColorless":{"description":"Destination Colorless","type":"string","example":"Yes"},"bandType":{"description":"Band Type","type":"string","example":"CNAND"},"multiChannelNLECM48Xtalk":{"format":"double","description":"Multi Channel NLE CM48 Xtalk","type":"number","example":123.45},"suggestedRegLoc":{"description":"Suggested Regeneration Location","type":"string","example":"abc"},"linearOSNREOL":{"format":"double","description":"Linear OSNR EOL","type":"number","example":123.45},"statusTotalPMD":{"description":"Status Total PMD","type":"string","example":"G"},"srcTxType":{"description":"Source TX Type","type":"string","example":"NCS1004_QPSK_200G_27%SDFEC_69GBd,Default( CLASS: BO )"},"demandFeasibilityStatusEOL":{"description":"Demand Feasibility Status EOL","type":"string","example":"G"},"statusSingleChannelNLE":{"description":"Status Single Channel NLE","type":"string","example":"G"},"osnrMarginValuesEOL":{"description":"OSNR Margin Values EOL","type":"array","items":{"format":"double","type":"number"},"example":[3.4]},"destination":{"description":"Destination","type":"string","example":"Site-1.T"},"singleChannelNLEScPenalty":{"format":"double","description":"Single Channel NLE SC Penalty","type":"number","example":123.45},"dstTxType":{"description":"Dst Tx Type","type":"string","example":"NCS1004_QPSK_200G_27%SDFEC_69GBd,Default( CLASS: BO )"},"powerPenalties":{"description":"Power Penalties","type":"string","example":"[APC:0.6700][PDG_PDL:0.5099]"},"rxPowerMarginEOL":{"format":"double","description":"Rx Power Margin EOL","type":"number","example":123.45},"statusOsnrMarginValuesEOL":{"description":"Status OSNR Margin Values EOL","type":"array","items":{"type":"string"},"example":["G"]},"eolOverloadValues":{"description":"EOL Overload Values","type":"array","items":{"format":"double","type":"number"},"example":[3.4]},"encryption":{"description":"True or False","type":"string","example":"True"},"osnrMarginValuesSOL":{"description":"OSNR Margin Values SOL","type":"array","items":{"format":"double","type":"number"},"example":[3.4]},"statusOverloadSOL":{"description":"Status Overload SOL","type":"string","example":"G"},"multiChannelNLEFwmXtalk":{"format":"double","description":"Multi-Channel NLE FWM Xtalk","type":"number","example":123.45},"isOOBOConsidered":{"description":"Is OOBO Considered","type":"string","example":"NO"},"nonLinearOSNREOL":{"format":"double","description":"Non-Linear OSNR EOL","type":"number","example":123.45},"protect":{"description":"Protect","type":"string","example":"Client 1+1"},"statusSE":{"description":"Status SE","type":"string","example":"G"},"gsnrSOL":{"format":"double","description":"GSNR SOL","type":"number","example":123.45},"srcColorless":{"description":"Src Colorless","type":"string","example":"Yes"},"srcOmniDir":{"description":"Source Omni Directional","type":"string","example":"Yes"},"powerVarianceEOL":{"format":"double","description":"Power Variance EOL","type":"number","example":123.45},"totalCD":{"format":"double","description":"Total CD","type":"number","example":123.45},"osnrEOL":{"format":"double","description":"OSNR EOL","type":"number","example":123.45},"statusOverloadEOL":{"description":"Status Overload EOL","type":"string","example":"G"},"osnrMarginEOL":{"format":"double","description":"OSNR Margin EOL","type":"number","example":123.45},"rxPowerEOL":{"format":"double","description":"RX Power EOL","type":"number","example":123.45},"statusTotalCD":{"description":"Status Total CD","type":"string","example":"G"},"dstOmniDir":{"description":"Destination Omni Directional","type":"string","example":"Yes"},"statusOsnrMarginValuesSOL":{"description":"Status OSNR Margin Values SOL","type":"array","items":{"type":"string"},"example":["34"]},"berTarget":{"description":"BER Target","type":"string","example":"1.0E-12"},"rxAtten":{"description":"RX Atten","type":"string","example":"None"},"totalPMD":{"format":"double","description":"Total Pmd","type":"number","example":123.45},"osnrPenalties":{"description":"OSNR Penalties","type":"string","example":"None"},"PF":{"description":"PF","type":"string","example":"None"},"osnrMarginSOL":{"format":"double","description":"OSNR Margin SOL","type":"number","example":123.45},"multiChannelNLEOptByPassXtalk":{"format":"double","description":"Multi-Channel NLE Opt By Pass Xtalk","type":"number","example":123.45},"rxPowerSOL":{"format":"double","description":"RX Power SOL","type":"number","example":123.45},"rxPowerMarginSOL":{"format":"double","description":"RX Power Margin SOL","type":"number","example":123.45}},"$$ref":"#/components/schemas/L0OpticalResults"},"ochUniqueKey":{"type":"string","description":"OCH Unique Key","example":"channel-100"},"sections":{"type":"array","items":{"type":"object","properties":{"channelLabel":{"description":"Channel Label","type":"string","example":"channel1"},"PF":{"description":"PF","type":"string","example":"PF"},"channelUid":{"description":"Channel UID","type":"string","example":"0f279527-74d9-45f2-a5db-a10773d2267e"},"protect":{"description":"Protect","type":"string","example":"Unprotected"}},"description":"OpticalResultsSection object","$$ref":"#/components/schemas/OpticalResultsSection"},"description":"Optical Results Section","example":[{"channelLabel":"channel12345","channelUid":"a9aabb77-4707-474a-ab5b-947320abd9c7","protect":"unprotected"}]}},"$$ref":"#/components/schemas/DWDMChannelOpticalResults"},"ODESpecific":{"description":"ODE Specific","example":{"packetChannel":false,"excludedChannels":["aa60cfd0-8c6c-4c95-a"],"existing":false,"unlocked":["this"]},"type":"object","properties":{"excludedChannels":{"description":"Excluded Channels","type":"array","items":{"type":"object","properties":{"excludedChannelUID":{"description":"Excluded Channel UID","type":"string","example":"58b039c3-e997-419e-8dfb-58ebb3d2f6f5"}},"description":"ExcludedChannel object","$$ref":"#/components/schemas/ExcludedChannel"},"example":[{"excludedChannelUID":"UID89501"}]},"existing":{"description":"Existing","type":"boolean","example":true},"OTNHops":{"format":"int32","description":"OTN Hops","type":"integer","example":123},"loadProfileTotal":{"description":"Load Profile Total","type":"array","items":{"type":"object","properties":{"qty":{"format":"double","description":"Quantity","type":"number","example":123.45},"type":{"description":"Type","type":"string","example":"label-100"}},"description":"LoadProfileExisting object","$$ref":"#/components/schemas/LoadProfileExisting"},"example":[{"type":"LoadProfileExisting","qty":23}]},"forced":{"description":"Forced Array","type":"array","items":{"type":"string"},"example":["UID89500"]},"packetChannel":{"description":"Packet Channel","type":"boolean","example":true},"loadProfileHealthy":{"description":"Load Profile Healthy","type":"array","items":{"type":"object","properties":{"qty":{"format":"double","description":"Quantity","type":"number","example":123.45},"type":{"description":"Type","type":"string","example":"label-100"}},"description":"LoadProfileExisting object","$$ref":"#/components/schemas/LoadProfileExisting"},"example":[{"type":"LoadProfileExisting","qty":23}]},"loadProfileExisting":{"description":"Load Profile Existing","type":"array","items":{"type":"object","properties":{"qty":{"format":"double","description":"Quantity","type":"number","example":123.45},"type":{"description":"Type","type":"string","example":"label-100"}},"description":"LoadProfileExisting object","$$ref":"#/components/schemas/LoadProfileExisting"},"example":[{"type":"LoadProfileExisting","qty":23}]},"capacityInUse":{"format":"double","description":"Capacity In Use","type":"number","example":123.45},"unlocked":{"description":"Unlock Array","type":"array","items":{"type":"string"},"example":["this"]},"capacity":{"format":"double","description":"Capacity","type":"number","example":123.45}},"$$ref":"#/components/schemas/ODESpecific"},"OSNR":{"type":"number","format":"double","description":"OSNR","example":12},"SRLGs":{"type":"array","items":{"type":"string"},"description":"SRLGs","example":["45677867666ftrt8"]},"VLANs":{"type":"array","items":{"type":"object","properties":{"Mbits":{"format":"double","description":"Mbits","type":"number","example":123.45},"LSPs":{"description":"LSPs","type":"array","items":{"type":"string"},"example":["45"]},"affinity":{"description":"affinity","type":"string","example":"a"}},"description":"VLAN object","$$ref":"#/components/schemas/VLAN"},"description":"VLANs","example":[{"mbits":10.4,"affinity":"affinity"}]},"timeslots":{"type":"array","items":{"type":"object","required":["UID"],"properties":{"restorationBandwidth":{"description":"Restoration Bandwidth","type":"boolean","example":true},"UID":{"description":"UID","type":"string","example":"f11c09bd-5b4d-45b6-af50-0ecf6805e1ee"},"demandID":{"description":"Demand ID","type":"string","example":"f11c09bd-5b4d-45b6-af50-0ecf6805e1ee"},"networkStatus":{"description":"Network Status","type":"string","example":"UNDISCOVERED"},"demandIndex":{"format":"int32","description":"Demand Index","type":"integer","example":123},"oduIDs":{"description":"ODU IDs","type":"array","items":{"type":"object","properties":{"from":{"format":"double","description":"From","type":"number","example":123.45},"to":{"format":"double","description":"To","type":"number","example":123.45}},"description":"Range object","$$ref":"#/components/schemas/Range"},"example":[{"start":1,"end":3}]},"businessStatus":{"description":"Business Status","type":"string","example":"FUTURE"},"demandPathType":{"description":"Demand Path Type","type":"string","example":"Fiber"},"unlocked":{"description":"Unlock Array","type":"array","items":{"type":"string"},"example":["this"]}},"description":"Timeslot object","$$ref":"#/components/schemas/Timeslot"},"description":"Timeslots","example":[{"UID":"48ff8427-0c33-4de6-b6ef-503a0ddcf90f","businessStatus":"FUTURE","demandID":"9954f683-2cf0-4ef5-8a37-08601c325690","oduIDs":[{"start":1,"end":2}],"networkStatus":"UNDISCOVERED","unlocked":["this"]}]},"L0DesignData":{"description":"L0Design Data","example":{"wavelength":-1,"path":["e9-61c8-4889-9"],"regenSites":["126e07e9-61c8-4889-91c5-245161a43e6a"],"srcCardType":"200G-SD-FEC","srcClientInterface":"Auto","srcTrunkType":"Auto","srcEdge":"Auto","srcWaveType":"Contentionless","dstCardType":"200G-SD-FEC","dstClientInterface":"Auto","dstTrunkType":"Auto","dstEdge":"Auto","dstWaveType":"Contentionless","trunkMode":"Auto","trafficType":"Alien"},"type":"object","properties":{"wavelength":{"format":"double","description":"Wavelength","type":"number","example":123.45},"dstClientInterface":{"description":"Destination Client Interface","type":"string","example":"Auto"},"srcEdge":{"description":"Source Edge","type":"string","example":"Auto"},"trunkMode":{"description":"Trunk Mode","type":"string","example":"Auto"},"trafficType":{"description":"Traffic Type","type":"string","example":"Alien"},"srcCardType":{"description":"Src Card Type","type":"string","example":"NCS1004_QPSK_SP_16QAM_200G_27%SDFEC_60GBd"},"srcTrunkType":{"description":"Source Trunk Type","type":"string","example":"Auto"},"srcWaveType":{"description":"Source Wave Type","type":"string","example":"Colorless"},"dstEdge":{"description":"Destination Edge","type":"string","example":"Auto"},"path":{"description":"Path","type":"array","items":{"type":"string"},"example":["6f91891f-39c4-4329-842e-27c158469531"]},"srcClientInterface":{"description":"Source Client Interface","type":"string","example":"Auto"},"dstWaveType":{"description":"Destination Wave Type","type":"string","example":"Colorless"},"regenSites":{"description":"Regen Sites","type":"array","items":{"type":"string"},"example":["236c124a-c5fe-4af9-877f-3b29dcc33304"]},"dstTrunkType":{"description":"Destination Trunk Type","type":"string","example":"Auto"},"dstCardType":{"description":"Destination Card Type","type":"string","example":"Auto"}},"$$ref":"#/components/schemas/L0DWDMChannelDesignData"},"L0OutputData":{"description":"L0Output Data","example":{"srcCardType":"200G-SD-FEC","srcClientInterface":"Auto","srcTrunkType":"Auto","srcEdge":"2ac9c245-351a-45d8-b5fb-e6939469097d","dstCardType":"200G-SD-FEC","dstClientInterface":"Auto","dstTrunkType":"Auto","dstEdge":"a20487cf-f657-44a3-b949-840eace45a2c","srcWaveType":"Contentionless","dstWaveType":"Contentionless"},"type":"object","properties":{"wavelength":{"format":"double","description":"Wavelength","type":"number","example":123.45},"dstClientInterface":{"description":"Destination Client Interface","type":"string","example":"SR-1 (QSFP-100G-SR4-S)"},"srcEdge":{"description":"Source Edge","type":"string","example":"edge-ncms-Site1-B"},"trunkMode":{"description":"Trunk Mode","type":"string","example":"Auto"},"srcCardType":{"description":"Src Card Type","type":"string","example":"400G-XP-LC - w/SD-FEC_15-NO_DE"},"srcTrunkType":{"description":"Source Trunk Type","type":"string","example":"ONS-CFP2-WDM"},"srcWaveType":{"description":"Source Wave Type","type":"string","example":"Colorless"},"dstEdge":{"description":"Destination Edge","type":"string","example":"edge-ncms-Site1-B"},"dstAddDropGroup":{"description":"Destination Add Drop Group","type":"string","example":"adddropgroup-244dd1e4-46e6-4965-b696-7851f9b6d51f"},"srcClientInterface":{"description":"Source Client Interface","type":"string","example":"SR-1 (QSFP-100G-SR4-S)"},"path":{"description":"Path","type":"array","items":{"type":"string"},"example":["fiberspan-ncms-Site1-B-ncms-Site2-A"]},"dstWaveType":{"description":"Destination Wave Type","type":"string","example":"Colorless"},"dstTrunkType":{"description":"Destination Trunk Type","type":"string","example":"ONS-CFP2-WDM"},"srcAddDropGroup":{"description":"Source Add Drop Group","type":"string","example":"adddropgroup-0f03dbc7-e606-4872-b7a2-a62aea698aa6"},"dstCardType":{"description":"Destination Card Type","type":"string","example":"400G-XP-LC - w/SD-FEC_15-NO_DE"}},"$$ref":"#/components/schemas/L0DWDMChannelOutputData"},"srcEdge":{"type":"string","description":"Source Edge","example":"2ac9c245-351a-45d8-b5fb-e6939469097d"},"dstEdge":{"type":"string","description":"Destination Edge","example":"a20487cf-f657-44a3-b949-840eace45a2c"},"forecast":{"type":"boolean","description":"Forecast","example":false},"encryption":{"type":"boolean","description":"True or False","example":false},"isSuggestedRegenApplied":{"type":"boolean","description":"Is Suggested Regen Applied","example":false},"suggestedRegenSites":{"type":"array","items":{"type":"string"},"description":"Suggested Regen Sites","example":["1","2"]},"tunerLoad":{"description":"Tuner Load","example":{"channelRequest":{"channelRequestId":"84f4fa51-445e-447c-90ca-58ac11d4c151-request","channelUid":"84f4fa51-445e-447c-90ca-58ac11d4c151","opticalSources":{"filteredFamilies":[{"pid":"NCS1004","filters":[{"dataRate":[100,200],"bitRateRange":[{"from":1,"to":2}],"baudRateRange":[{"from":20,"to":30}],"fecType":["FEC_SED_15"],"subOpMode":["1_E"],"modulationFormat":["16QAM"]}]}]},"numOfResults":5,"operZone":"GREEN","resultType":"BEST_OSNR"}},"type":"object","properties":{"channelRequest":{"description":"Channel Request","example":{"channelRequest":{"channelRequestId":"f6226908-d7ed-4766-afcc-9966141ae826-request","channelUid":"f6226908-d7ed-4766-afcc-9966141ae826","numOfResults":5,"operZone":"GREEN","resultType":"BEST_OSNR"}},"type":"object","properties":{"channelRequestId":{"type":"string","description":"Channel RequestId","example":"8801202e-e907-4c84"},"channelUid":{"type":"string","description":"Channel Uid","example":"8801202e-e907-4c84"},"opticalSources":{"description":"Optical Sources","example":{"filteredFamilies":[{"pid":"NCS1004","filters":[{"dataRate":[100,200],"bitRateRange":[{"from":1,"to":2}],"baudRateRange":[{"from":20,"to":30}]}]}]},"type":"object","properties":{"filteredFamilies":{"description":"Filtered Families","type":"array","items":{"type":"object","properties":{"pid":{"description":"PID","type":"string","example":"45678"},"filters":{"description":"Filters","type":"array","items":{"type":"object","properties":{"bitRateRange":{"description":"Bit Rate Range","type":"array","items":{"type":"object","properties":{"from":{"format":"double","description":"From","type":"number","example":123.45},"to":{"format":"double","description":"To","type":"number","example":123.45}},"description":"Range object","$$ref":"#/components/schemas/Range"},"example":[{"start":10,"end":4}]},"subOpMode":{"description":"Sub Operation Mode","type":"array","items":{"type":"string"},"example":["1_E"]},"baudRateRange":{"description":"Baud Rate Range","type":"array","items":{"type":"object","properties":{"from":{"format":"double","description":"From","type":"number","example":123.45},"to":{"format":"double","description":"To","type":"number","example":123.45}},"description":"Range object","$$ref":"#/components/schemas/Range","example":{"start":10,"end":4}},"example":[{"start":10,"end":4}]},"modulationFormat":{"description":"Modulation Format","type":"array","items":{"type":"string"},"example":["16QAM"]},"dataRate":{"description":"Data Rate","type":"array","items":{"format":"int32","type":"integer"},"example":[34]},"fecType":{"description":"FEC Type","type":"array","items":{"type":"string"},"example":["FEC_SDF_15"]}},"description":"OptWMFilters object","$$ref":"#/components/schemas/OptWMFilters"},"example":[{"dataRate":[2,3,4],"fecType":["SED_FEC_15"]}]}},"description":"FilteredFamily object","$$ref":"#/components/schemas/FilteredFamily"},"example":[{"pid":"NCS1010-SA="}]},"aliens":{"description":"Aliens","type":"array","items":{"type":"string"},"example":["ABC"]}},"$$ref":"#/components/schemas/OpticalSources"},"numOfResults":{"type":"integer","format":"int32","description":"Number Of Results","example":1},"diagnosticOptions":{"description":"Diagnostic Options","example":{"enabled":false,"maxEntriesPerType":2},"type":"object","properties":{"maxEntriesPerType":{"format":"int32","description":"Max Entries Per Type","type":"integer","example":123},"enabled":{"description":"Enabled","type":"boolean","example":true}},"$$ref":"#/components/schemas/WMDiagnosticOptions"},"operZone":{"type":"string","description":"UNKNOWN or GREEN or YELLOW or ORANGE or RED","enum":["UNKNOWN","GREEN","YELLOW","ORANGE","RED"],"example":"UNKNOWN"},"sigmaNum":{"type":"integer","format":"int32","description":"Sigma Number","example":1},"maxSpectralWidth":{"description":"Max Spectral Width","example":{"width":45.9,"isNyquist":false},"type":"object","properties":{"width":{"format":"double","description":"Width","type":"number","example":123.45},"isNyquist":{"description":"Is Nyquist","type":"boolean","example":true}},"$$ref":"#/components/schemas/MaxSpectralWidth"},"allSpectrumAvailable":{"type":"boolean","description":"True or False","example":false},"resultType":{"type":"string","description":"MAX_CAPACITY or BEST_OSNR","example":"MAX_CAPACITY","enum":["MAX_CAPACITY","BEST_OSNR"]}},"$$ref":"#/components/schemas/ChannelRequest"}},"$$ref":"#/components/schemas/TunerLoad"},"tunerResult":{"type":"object","properties":{"channelResponse":{"type":"object","properties":{"channelRequestId":{"type":"string","description":"channel RequestId","example":"87765298u-8ui65437868"},"channelUid":{"type":"string","description":"channel UID","example":"97687765298u-8ui56"},"result":{"description":"Result","example":{"resultCode":"SUCCESS"},"type":"object","properties":{"resultCode":{"description":"Result Code","type":"string","enum":["SUCCESS","FAILURE"],"example":"SUCCESS"},"cause":{"description":"Cause object","type":"object","properties":{"localizedMessage":{"description":"Localized Message","type":"string","example":"A"},"cause":{"description":"Cause object","type":"object","properties":{"localizedMessage":{"description":"Localized Message","type":"string","example":"abcs"},"stackTrace":{"type":"array","description":"stackTrace object","items":{"type":"object","properties":{"fileName":{"description":"File Name","type":"string","example":"gene"},"nativeMethod":{"description":"Native Method","type":"boolean","example":true},"methodName":{"description":"Method Name","type":"string","example":"updatSiteACPowerCable"},"className":{"description":"Class Name","type":"string","example":"updatSiteACPowerCable"},"lineNumber":{"description":"Line Number","format":"int32","type":"integer","example":3}}},"example":[{"fileName":"abcx.xsl","methodName":"updatSiteACPowerCable","nativeMethod":true,"className":"updatSite","lineNumber":3}]},"suppressed":{"type":"array","description":"suppressed object","items":{"type":"object","properties":{"localizedMessage":{"description":"Localized Message","type":"string","example":"A"},"stackTrace":{"type":"array","description":"stackTrace object","items":{"type":"object","properties":{"fileName":{"description":"File Name","type":"string","example":"baudRate"},"nativeMethod":{"description":"True or False","type":"boolean","example":true},"methodName":{"description":"Method Name","type":"string","example":"updatBaudRate"},"className":{"description":"Class Name","type":"string","example":"BZ"},"lineNumber":{"format":"int32","description":"Line Number","type":"integer","example":123}}}},"message":{"description":"A human-readable message providing more details about the error","type":"string","example":"analysis-failed"}}}},"message":{"description":"A human-readable message providing more details about the error","type":"string","example":"analysis-failed"}}},"stackTrace":{"type":"array","description":"stackTrace object","items":{"type":"object","properties":{"fileName":{"description":"File Name","type":"string","example":"pulsor.xsl"},"nativeMethod":{"description":"Native Method","type":"boolean","example":true},"methodName":{"description":"Method Name","type":"string","example":"updateAlien"},"className":{"description":"Class Name","type":"string","example":"AlineServiceImpl"},"lineNumber":{"format":"int32","description":"Line Number","type":"integer","example":123}}}},"suppressed":{"type":"array","description":"suppressed object","items":{"type":"object","properties":{"localizedMessage":{"description":"Localized Message","type":"string","example":"A"},"stackTrace":{"type":"array","description":"stackTrace object","items":{"type":"object","properties":{"fileName":{"description":"File Name","type":"string","example":"A"},"nativeMethod":{"description":"Native Method","type":"boolean","example":true},"methodName":{"description":"Method Name","type":"string","example":"A"},"className":{"description":"Class Name","type":"string","example":"A"},"lineNumber":{"format":"int32","description":"Line Number","type":"integer","example":123}}}},"message":{"description":"A human-readable message providing more details about the error","type":"string","example":"A"}}}},"message":{"description":"A human-readable message providing more details about the error","type":"string","example":"exampleString"}}}},"$$ref":"#/components/schemas/Result"},"opticalResults":{"type":"array","description":"Optical Results","example":[{"opticalInterfaceId":"NCS1K4-1_2T-K9_2_SD_FEC_27_DE_OFF_R600G_64QAM","maxChannelCount":4}],"items":{"type":"object","properties":{"isFlexiOpticalSource":{"description":"Is Flexi Optical Source","type":"boolean","example":true},"opticalInterfaceId":{"description":"Optical Interface ID","type":"string","example":"456545"},"opticalInterfaceName":{"description":"Optical Interface Name","type":"string","example":"Alien"},"optValResultForward":{"description":"Optical Value Result Forward","$ref":"#/components/schemas/OptValResult","example":{"osnrMargin":5.5,"powerMargin":6.3}},"maxChannelCount":{"format":"double","description":"Max Channel Count","type":"number","example":123.45},"spectrumAllocation":{"description":"Spectrum Allocation","example":{"channelWidth":4.6,"carrierWidth":3.4},"type":"object","properties":{"carrierWidth":{"format":"double","description":"Carrier Width","type":"number","example":123.45},"symbolRate":{"format":"double","description":"Symbol Rate","type":"number","example":123.45},"filteringGuardBand":{"format":"double","description":"Filtering Guard Band","type":"number","example":123.45},"channelWidth":{"format":"double","description":"Channel Width","type":"number","example":123.45},"modulationGuardBand":{"format":"double","description":"Modulation Guard Band","type":"number","example":123.45},"spectralEfficiency":{"format":"double","description":"Spectral Efficiency","type":"number","example":123.45}},"$$ref":"#/components/schemas/SpectrumAllocation"},"optValResultReverse":{"description":"Optical Value Result Reverse","$ref":"#/components/schemas/OptValResult","example":{"osnrMargin":5.5,"powerMargin":6.3}}},"description":"Optical Results","$$ref":"#/components/schemas/OpticalResult","example":{"opticalInterfaceId":"NCS1K4-1_2T-K9_2_SD_FEC_27_DE_OFF_R600G_64QAM","maxChannelCount":4}}},"diagnostics":{"type":"array","description":"Diagnostics","items":{"type":"object","properties":{"opticalInterfaceId":{"type":"string","description":"Optical Interface ID","example":"3456"},"error":{"$ref":"#/components/schemas/Error","description":"Error","example":{"code":"ERR002","message":"Missing required field"}}},"description":"Diagnostic object","$$ref":"#/components/schemas/Diagnostic"},"example":[{"opticalInterfaceId":"eef14c85-b4f0-434e","error":{"code":"ERR002","message":"Missing required field"}}]}},"description":"Channel Response","$$ref":"#/components/schemas/ChannelResponse","example":{"channelRequestId":"84f4fa51-445e-447c-90ca-58ac11d4c151-request","channelUid":"84f4fa51-445e-447c-90ca-58ac11d4c151","opticalResults":[{"opticalInterfaceId":"interface","maxChannelCount":4}]}}},"description":"Tuner Result","$$ref":"#/components/schemas/TunerResult","example":{"channelResponse":{"channelRequestId":"84f4fa51-445e-447c-90ca-58ac11d4c151-request","channelUid":"84f4fa51-445e-447c-90ca-58ac11d4c151","opticalResults":[{"opticalInterfaceId":"interface","maxChannelCount":4}]}}},"isTunerChannel":{"type":"boolean","description":"True or False","example":false},"demandError":{"type":"string","description":"Demand Error","example":"Routing Failure"}},"description":"DWDMChannel object","$$ref":"#/components/schemas/DWDMChannel","title":"DWDMChannel"}}