{"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":{"type":"object","required":["UID"],"properties":{"unitWeight":{"format":"double","description":"Unit Weight","type":"number","example":123.45},"UID":{"description":"UID","type":"string","example":"d4bcdce6-65ff-45a3-b368-0c8cc9f6ba34"},"totalPowerConsumed":{"format":"double","description":"Total Power Consumed","type":"number","example":123.45},"entityType":{"description":"Entity Type","type":"string","example":"Rack"},"forced":{"description":"Forced Array","type":"array","items":{"type":"string"},"example":["344545"]},"forecast":{"description":"Forecast","type":"boolean","example":true},"typicalPowerConsumed":{"format":"double","description":"Typical Power Consumed","type":"number","example":123.45},"label":{"description":"Label","type":"string","example":"rack-1"},"front":{"type":"object","properties":{"UID":{"description":"UID","type":"string","example":"a40b0f21-6d6c-42fd-b53f-921150d8b6a5"},"shelf":{"description":"Shelf","type":"array","items":{"type":"object","properties":{"unitWeight":{"format":"double","description":"Unit Weight","type":"number","example":123.45},"usbSlot":{"description":"USB Slot","type":"string","example":"1"},"clei":{"description":"Clei","type":"string","example":"1"},"ruPosition":{"description":"RU Position","type":"string","example":"2"},"ruSize":{"description":"RU Size","type":"string","example":"34"},"totalPowerConsumed":{"format":"double","description":"Total Power Consumed","type":"number","example":123.45},"forced":{"description":"Forced Array","type":"array","items":{"type":"string"},"example":["23444"]},"networkStatus":{"description":"Network Status","type":"string","example":"UNDISCOVERED"},"groups":{"description":"Groups","type":"object","properties":{"siteGroup":{"description":"Site Group","type":"array","items":{"type":"string"},"example":["A"]},"edgeGroup":{"description":"Edge Group","type":"array","items":{"type":"string"},"example":["A"]}},"$$ref":"#/components/schemas/Groups"},"configMode":{"description":"Config Mode","type":"string","example":"3"},"pid":{"description":"PID","type":"string","example":"NCS1010-SA="},"businessStatus":{"description":"Business Status","type":"string","example":"FUTER"},"typicalPowerConsumed":{"format":"double","description":"Typical Power Consumed","type":"number","example":123.45},"forecast":{"description":"Forecast","type":"boolean","example":true},"type":{"description":"Type","type":"string","example":"label-100"},"shelfName":{"description":"Shelf Name","type":"string","example":"PassiveShelf"},"unlocked":{"description":"Unlock Array","type":"array","items":{"type":"string"},"example":["this"]},"physicalPort":{"description":"Physical Port","type":"array","items":{"type":"object","required":["UID"],"properties":{"provisionedPortInfo":{"description":"Provisioned Port Info","example":{"connectedCardName":"16-AD-CCOFS","connectedCardPosition":"Site-1/Rack-1/Shelf-1/Slot-15/Port-48"},"type":"object","properties":{"wavelength":{"description":"Wavelength","type":"string","example":"234"},"connectedCardPosition":{"description":"Connected Card Position","type":"string","example":"Site-1/Rack-1/Shelf-1/Slot-15/Port-48"},"edgeSideLabel":{"description":"Edge Side Label","type":"string","example":"A"},"encryption":{"description":"True or False","type":"string","example":"No"},"fec":{"description":"FEC","type":"string","example":"SD_FEC_15"},"rate":{"description":"Rate","type":"string","example":"300"},"p/f":{"description":"P/F","type":"string","example":"0"},"ppm":{"description":"PPM","type":"string","example":"0"},"connectedCardName":{"description":"Connected Card Name","type":"string","example":"16-AD-CCOFS"},"type":{"description":"Type","type":"string","example":"16-AD-CCOFS"},"interface":{"description":"Interface","type":"string","example":"Auto"},"demands":{"description":"Demands","type":"array","items":{"type":"string"},"example":["234455666"]}},"$$ref":"#/components/schemas/ProvisionedPortInfo"},"role":{"description":"Role","type":"string","example":"A"},"connectorLabel":{"description":"Connector Label","type":"string","example":"LINE"},"networkStatus":{"description":"Network Status","type":"string","example":"UNDISCOVERED"},"businessStatus":{"description":"Business Status","type":"string","example":"FUTURE"},"label":{"description":"Label","type":"string","example":"label1"},"subports":{"description":"Subports","type":"array","items":{"$ref":"#/components/schemas/Subport","$$ref":"#/components/schemas/Subport"},"example":[{"UID":"228ff-609d-48a0-9ef4-5ab5a0d9fbdc","businessStatus":"FUTURE"}]},"type":{"description":"Type","type":"string","example":"COSM"},"cosmLabel":{"description":"COSM Label","type":"string","example":"COSM"},"timeslots":{"description":"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"},"example":[{"UID":"4949fc32-dde6-4212-b834-8bda6429e585","elementType":"Timeslot","businessStatus":"UNDISCOVERED","demandID":"761873d1-657d-4350-84aa-8e7bf558cb24","oduIDs":[{"start":1,"end":3}],"networkStatus":"FUTURE","restorationBandwidth":false,"unlocked":["this"]}]},"portNumber":{"format":"int32","description":"Port Number","type":"integer","example":123},"subportCount":{"format":"int32","description":"Subport Count","type":"integer","example":123},"unlocked":{"description":"Unlock Array","type":"array","items":{"type":"string"},"example":["this"]},"UID":{"description":"UID","type":"string","example":"094228ff-609d-48a0-9ef4-5ab5a0d9fbdc"},"demandID":{"description":"Demand ID","type":"string","example":"param-ncms-Site1-1-1-CHASSIS_M15-16-6"},"portCapacity":{"format":"int32","description":"Port Capacity","type":"integer","example":123},"parentPortUID":{"description":"Parent Port UID","type":"string","example":"NCS1004_QPSK_SP_16QAM_200G_27%SDFEC_60GBd"},"systemPort":{"format":"int32","description":"System Port","type":"integer","example":123},"trunkInfo":{"description":"Trunk Info","example":{"UID":"b08ec4-ad18-4aed-abfb-70f312922bf","baudRate":138.7},"type":"object","required":["UID"],"properties":{"baudRate":{"format":"double","description":"Baud-rate value","type":"number","example":123.45},"UID":{"description":"UID","type":"string","example":"e5b87827-a853-4216-8ffe-4bd25a55094d"},"fecMode":{"description":"FEC Mode","type":"string","example":"otu-bag-sd27-fec"},"bitsPerSymbol":{"format":"int32","description":"Bits Per Symbol","type":"integer","example":2},"modulationType":{"description":"Modulation Type","type":"string","example":"mod-qpsk"}},"$$ref":"#/components/schemas/TrunkInfo"}},"description":"PhysicalPort object","$$ref":"#/components/schemas/PhysicalPort"},"example":[{"UID":"port-8fc5-4b73-ae2c-9ef04e2a6c54-1-1001-MF_6RU-14-65","label":"DEG RX TX - 1","businessStatus":"FUTURE","networkStatus":"UNDISCOVERED","portNumber":65}]},"UID":{"description":"UID","type":"string","example":"4567787777"},"logicalPort":{"description":"Logical Port","type":"array","items":{"type":"object","required":["UID"],"properties":{"provisionedPortInfo":{"description":"Provisioned Port Info","example":{"connectedCardName":"16-AD-CCOFS","connectedCardPosition":"Site-1/Rack-1/Shelf-1/Slot-15/Port-48"},"type":"object","properties":{"wavelength":{"description":"Wavelength","type":"string","example":"234"},"connectedCardPosition":{"description":"Connected Card Position","type":"string","example":"Site-1/Rack-1/Shelf-1/Slot-15/Port-48"},"edgeSideLabel":{"description":"Edge Side Label","type":"string","example":"A"},"encryption":{"description":"True or False","type":"string","example":"No"},"fec":{"description":"FEC","type":"string","example":"SD_FEC_15"},"rate":{"description":"Rate","type":"string","example":"300"},"p/f":{"description":"P/F","type":"string","example":"0"},"ppm":{"description":"PPM","type":"string","example":"0"},"connectedCardName":{"description":"Connected Card Name","type":"string","example":"16-AD-CCOFS"},"type":{"description":"Type","type":"string","example":"16-AD-CCOFS"},"interface":{"description":"Interface","type":"string","example":"Auto"},"demands":{"description":"Demands","type":"array","items":{"type":"string"},"example":["234455666"]}},"$$ref":"#/components/schemas/ProvisionedPortInfo"},"portMode":{"description":"Port Mode","type":"string","example":"connection"},"ODUTSGranularity":{"description":"ODU TS Granularity","type":"string","example":"3"},"connectorLabel":{"description":"Connector Label","type":"string","example":"connectorLabel-100"},"label":{"description":"Label","type":"string","example":"label-199"},"subports":{"description":"Subports","type":"array","items":{"$ref":"#/components/schemas/Subport","$$ref":"#/components/schemas/Subport"},"example":[{"UID":"228ff-609d-48a0-9ef4-5ab5a0d9fbdc","businessStatus":"FUTURE"}]},"type":{"description":"Type","type":"string","example":"COSM"},"cosmLabel":{"description":"COSM Label","type":"string","example":"cosm-label-1"},"timeslots":{"description":"Timeslots","type":"string","example":"4"},"portNumber":{"format":"int32","description":"Port Number","type":"integer","example":123},"subportCount":{"format":"int32","description":"Subport Count","type":"integer","example":123},"physicalPort":{"description":"Physical Port","type":"string","example":"2"},"UID":{"description":"UID","type":"string","example":"uid4e2a-8769-de7cd685afeb-B012-TO-B014-"},"portCapacity":{"format":"int32","description":"Port Capacity","type":"integer","example":123},"demandID":{"description":"Demand ID","type":"string","example":"d4e2a-8769-de7cd685afeb-B012-TO-B014-"},"parentPortUID":{"description":"Parent Port UID","type":"string","example":"4e2a-8769-de7cd685afeb-B012-TO-B014"},"systemPort":{"format":"int32","description":"System Port","type":"integer","example":123},"traffic":{"description":"Traffic","type":"array","items":{"type":"string"},"example":["100GE"]}},"description":"LogicalPort object","$$ref":"#/components/schemas/LogicalPort"},"example":[{"UID":"c2909f56-c7c1-4b27-883a-9e381fafcb2e","alias":"Logical Port","elementType":"SSONMediaChannel","label":"Channellabel","type":"MF-UPG-4"}]},"shelfNumber":{"description":"Shelf Number","type":"string","example":"1"},"front":{"type":"object","properties":{"card":{"description":"Card","type":"array","items":{"$ref":"#/components/schemas/Card"},"example":[{"UID":"card-9bb424a9-4fc2-4f33-a34a-7303b0eaf0e5","pid":"NCS1K-MD-32E-C=","type":"NCS1K-MD-32E-C","businessStatus":"FUTURE","networkStatus":"UNDISCOVERED","groups":{"edgeGroup":["bcf1f943-9aec-40d6-9269-178859ed7ec6","b5341aa8-1403-4d61-8ca5-2c3709e5aa32"],"siteGroup":["774cd045-be7f-4de9-9828-f1b95bb6c786"]},"slots":["1"],"clei":"N/A","forecast":false,"maxPowerConsumption":3.5,"typicalPowerConsumption":0,"unitWeight":3.15}]}},"description":"Front","$$ref":"#/components/schemas/ShelfFront","example":{"elementType":"Front"}},"uniqueId":{"description":"Unique ID","type":"string","example":"2"}},"description":"Shelf object","$$ref":"#/components/schemas/Shelf"},"example":[{"UID":"0408733c-75ad-4d53-b725-d5787e9c1407","tyoe":"ShelfPDP"}]}},"description":"Front","$$ref":"#/components/schemas/RackFront","example":{"UID":"123456Yt67","shelf":[{"UID":"shelf-5a8bfc2f-91b0-4a81-ad58-ffc1ad8c5c81-1-1002-MF_1RU","PID":"NCS2K-MF-1RU=","type":"PASSIVE_SHELF_MF_1RU","shelfName":"PASSIVE_SHELF_MF_1RU","shelfNumber":"1002"}]}},"unlocked":{"description":"Unlock Array","type":"array","items":{"type":"string"},"example":["this"]},"rackNumber":{"description":"Rack Number","type":"string","example":"1"}},"description":"Rack object","$$ref":"#/components/schemas/Rack","title":"Rack"}}