NCS1K - Cisco Optical Network Controller 25.1.x API - Cisco DevNet

{"type":"model","meta":{"id":"/apps/pubhub/media/conc-2511/d77fe2fa1c66c5533550637c8fa49491e06b8c79/475cb62a-52dd-3ab2-a3a0-6af7637d32e0","info":{"title":"Inventory Service","description":"Inventory Service api documentation","contact":{},"license":{"name":"ONC-AE-License","url":"https://www.cisco.com"},"version":"1.0.0-25.1.1"},"security":[{"basicAuth":[]}],"tags":[{"name":"Inventory Service api documentation"}],"x-parser-conf":{"overview":{"markdownPath":"reference/2431/inventory-service.md"},"serverConfig":"full","enableAuthEditing":true,"httpBasic":{"username":"api-user","password":"encrypted-password@123"}},"openapi":"3.0.1","servers":[{"url":"http://localhost","description":"Generated server url"}],"securitySchemes":{"basicAuth":{"type":"http","description":"Basic authentication scheme","scheme":"basic"}}},"spec":{"required":["UID"],"type":"object","properties":{"id":{"type":"string","nullable":true},"entityType":{"type":"string","nullable":true},"UID":{"type":"string"},"hierarchicalUID":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"businessStatus":{"type":"string","nullable":true},"networkStatus":{"type":"string","nullable":true},"siteAddress":{"type":"string","nullable":true},"clientPorts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"portType":{"type":"string","nullable":true},"qty":{"type":"integer","format":"int32","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/ClientPort"}},"trunkPorts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"portType":{"type":"string","nullable":true},"qty":{"type":"integer","format":"int32","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/ClientPort"}},"configurations":{"type":"string","nullable":true},"edgesSides":{"type":"array","nullable":true,"items":{"type":"object","properties":{"hierarchicalUID":{"type":"string","nullable":true},"direction":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"deviceUID":{"type":"string","nullable":true},"extendedEdgeSideUID":{"type":"string","nullable":true},"lineRX":{"type":"string","nullable":true},"lineTX":{"type":"string","nullable":true},"unlocked":{"type":"array","nullable":true,"items":{"type":"string"}},"forced":{"type":"array","nullable":true,"items":{"type":"string"}},"l0DesignData":{"type":"object","properties":{"colorless":{"type":"boolean","nullable":true},"contentionless":{"type":"boolean","nullable":true},"contentionlessMode":{"type":"string","nullable":true},"colorless100GPorts":{"type":"integer","format":"int32","nullable":true},"preCBandAmplifier":{"type":"string","nullable":true},"bstCBandAmplifier":{"type":"string","nullable":true},"preCBandOutPower":{"type":"number","format":"double","nullable":true},"bstCBandOutPower":{"type":"number","format":"double","nullable":true},"preAttIn":{"type":"string","nullable":true},"preAttOut":{"type":"string","nullable":true},"bstAttIn":{"type":"string","nullable":true},"bstAttOut":{"type":"string","nullable":true},"ramanAmplifier":{"type":"string","nullable":true},"ramanGain":{"type":"number","format":"double","nullable":true},"ramanCopGain":{"type":"number","format":"double","nullable":true},"preTilt":{"type":"number","format":"double","nullable":true},"bstTilt":{"type":"number","format":"double","nullable":true},"ramanTilt":{"type":"number","format":"double","nullable":true},"ramanCopTilt":{"type":"number","format":"double","nullable":true},"logoParameters":{"type":"object","properties":{"staticData":{"type":"boolean","nullable":true},"linearXTAvg":{"type":"number","format":"double","nullable":true},"linearXTSig":{"type":"number","format":"double","nullable":true},"nonLinearXTAvg":{"type":"number","format":"double","nullable":true},"nonLinearXTSig":{"type":"number","format":"double","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/L0LogoParameters"},"unlocked":{"type":"array","nullable":true,"items":{"type":"string"}},"forced":{"type":"array","nullable":true,"items":{"type":"string"}}},"nullable":true,"$$ref":"#/components/schemas/L0EdgeDesignData"},"l0OutputData":{"type":"object","properties":{"preOutputPower":{"type":"number","format":"double","nullable":true},"preTilt":{"type":"number","format":"double","nullable":true},"preEolGain":{"type":"number","format":"double","nullable":true},"preBolGain":{"type":"number","format":"double","nullable":true},"preControlMode":{"type":"string","nullable":true},"preGainRange":{"type":"number","format":"double","nullable":true},"bstOutputPower":{"type":"number","format":"double","nullable":true},"bstTilt":{"type":"number","format":"double","nullable":true},"bstEolGain":{"type":"number","format":"double","nullable":true},"bstBolGain":{"type":"number","format":"double","nullable":true},"bstControlMode":{"type":"string","nullable":true},"bstGainRange":{"type":"number","format":"double","nullable":true},"outputPowerEmbedded":{"type":"number","format":"double","nullable":true},"ramanGain":{"type":"number","format":"double","nullable":true},"ramanTilt":{"type":"number","format":"double","nullable":true},"postAmpInputPower":{"type":"number","format":"double","nullable":true},"ramanCopGain":{"type":"number","format":"double","nullable":true},"ramanCopTilt":{"type":"number","format":"double","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/L0EdgeOutputData"},"uid":{"type":"string","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/EdgeSide"}},"BOM":{"type":"array","nullable":true,"items":{"type":"object","properties":{"gPL":{"type":"number","format":"double","nullable":true},"pID":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"discount":{"type":"number","format":"double","nullable":true},"extendedPrice":{"type":"number","format":"double","nullable":true},"price":{"type":"number","format":"double","nullable":true},"qty":{"type":"integer","format":"int32","nullable":true},"materialID":{"type":"string","nullable":true},"clei":{"type":"string","nullable":true},"id":{"type":"string","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/NCS1KBOM"}},"unlocked":{"type":"array","nullable":true,"items":{"type":"string"}},"forced":{"type":"array","nullable":true,"items":{"type":"string"}}},"nullable":true,"$$ref":"#/components/schemas/NCS1K","title":"NCS1K"}}