Return information about OTS link by UUID - Cisco Optical Network Controller 25.1.x API

{"type":"api","title":"Return information about OTS link by UUID","meta":{"id":"/apps/pubhub/media/conc-2511/d77fe2fa1c66c5533550637c8fa49491e06b8c79/beb9f63e-65b6-3d1c-90d0-b3ffdd996795","info":{"title":"Topology Service","description":"Topology 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":"Topology API Documentation"}],"x-parser-conf":{"overview":{"markdownPath":"reference/2431/topologyservice.md"},"serverConfig":"full","enableAuthEditing":true,"httpBasic":{"username":"api-user","password":"encrypted-password@123"}},"openapi":"3.0.1","servers":[{"url":"https://cisco-onc-ip:8443/onc-topology-service/","description":"External API server"}],"securitySchemes":{"basicAuth":{"type":"http","description":"Basic authentication scheme","scheme":"basic"}}},"spec":{"tags":["Topology API Documentation"],"summary":"Return information about OTS link by UUID","description":"This API is used to fetch the information about OTS link by UUID.","operationId":"getOTSinkForUID","parameters":[{"name":"otsLinkUID","in":"path","description":"Id of the OTS link","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"hierarchicalUID":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"srcSite":{"type":"string","nullable":true},"sourceEdge":{"type":"string","nullable":true},"hierarchicalSourceEdge":{"type":"string","nullable":true},"dstSite":{"type":"string","nullable":true},"destinationEdge":{"type":"string","nullable":true},"hierarchicalDestinationEdge":{"type":"string","nullable":true},"l0DesignData":{"type":"object","properties":{"lengthBasedLoss":{"type":"boolean","nullable":true},"isLOGOEnabled":{"type":"boolean","nullable":true},"connectorLossIn":{"type":"number","format":"double","nullable":true},"connectorLossOut":{"type":"number","format":"double","nullable":true},"rdFactor":{"type":"number","format":"double","nullable":true},"cbandRule":{"type":"string","nullable":true},"qdcband":{"type":"number","format":"double","nullable":true},"cdcband":{"type":"number","format":"double","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/L0FiberDesignData"},"bidirectional":{"type":"boolean","nullable":true},"businessStatus":{"type":"string","nullable":true},"networkStatus":{"type":"string","nullable":true},"adminState":{"type":"string","nullable":true},"serviceState":{"type":"string","nullable":true},"fiberType":{"type":"string","nullable":true},"length":{"type":"number","format":"double","nullable":true},"loss":{"type":"number","format":"double","nullable":true},"ageingLoss":{"type":"number","format":"double","nullable":true},"ageingFactor":{"type":"number","format":"double","nullable":true},"attenuationCoeff":{"type":"number","format":"double","nullable":true},"pmd":{"type":"number","format":"double","nullable":true},"dcnExtension":{"type":"boolean","nullable":true},"oscFrameType":{"type":"string","nullable":true},"ramanAmplified":{"type":"boolean","nullable":true},"measurementUnits":{"type":"string","nullable":true},"srcDeviceUID":{"type":"string","nullable":true},"dstDeviceUID":{"type":"string","nullable":true},"forward":{"type":"object","properties":{"hierarchicalUID":{"type":"string","nullable":true},"srcDeviceUID":{"type":"string","nullable":true},"dstDeviceUID":{"type":"string","nullable":true},"srcSite":{"type":"string","nullable":true},"sourceEdge":{"type":"string","nullable":true},"sourcePort":{"type":"string","nullable":true},"hierarchicalSourceEdge":{"type":"string","nullable":true},"hierarchicalSourcePort":{"type":"string","nullable":true},"dstSite":{"type":"string","nullable":true},"destinationEdge":{"type":"string","nullable":true},"destinationPort":{"type":"string","nullable":true},"hierarchicalDestinationEdge":{"type":"string","nullable":true},"hierarchicalDestinationPort":{"type":"string","nullable":true},"bidirectional":{"type":"boolean","nullable":true},"businessStatus":{"type":"string","nullable":true},"networkStatus":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"length":{"type":"number","format":"double","nullable":true},"loss":{"type":"number","format":"double","nullable":true},"ageingLoss":{"type":"number","format":"double","nullable":true},"ageingFactor":{"type":"number","format":"double","nullable":true},"attenuationCoeff":{"type":"number","format":"double","nullable":true},"pmd":{"type":"number","format":"double","nullable":true},"measurementUnits":{"type":"string","nullable":true},"fiberType":{"type":"string","nullable":true},"isOsnrDataValid":{"type":"boolean","nullable":true},"noise":{"type":"number","format":"double","nullable":true},"sigma":{"type":"number","format":"double","nullable":true},"unlocked":{"type":"array","nullable":true,"items":{"type":"string"}},"forced":{"type":"array","nullable":true,"items":{"type":"string"}},"opticalParams":{"type":"object","properties":{"isValid":{"type":"boolean","nullable":true},"noise":{"type":"number","format":"double","nullable":true},"noiseSigma":{"type":"number","format":"double","nullable":true},"chromaticDispersion":{"type":"number","format":"double","nullable":true},"chromaticDispersionSlope":{"type":"number","format":"double","nullable":true},"pdl":{"type":"number","format":"double","nullable":true},"pmd":{"type":"number","format":"double","nullable":true},"fgdrFilters":{"type":"array","nullable":true,"items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"count":{"type":"integer","format":"int32","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/OpticalFilterCounter"}},"sfFilters":{"type":"array","nullable":true,"items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"count":{"type":"integer","format":"int32","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/OpticalFilterCounter"}},"dropPower":{"type":"number","format":"double","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/NCMSOpticalParams"},"channelNumber":{"type":"integer","format":"int32","nullable":true},"pmdCoefficient":{"type":"number","format":"double","nullable":true},"connectorLossIn":{"type":"number","format":"double","nullable":true},"connectorLossOut":{"type":"number","format":"double","nullable":true},"adminState":{"type":"string","nullable":true},"serviceState":{"type":"string","nullable":true},"uid":{"type":"string","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/Fiber"},"reverse":{"type":"object","properties":{"hierarchicalUID":{"type":"string","nullable":true},"srcDeviceUID":{"type":"string","nullable":true},"dstDeviceUID":{"type":"string","nullable":true},"srcSite":{"type":"string","nullable":true},"sourceEdge":{"type":"string","nullable":true},"sourcePort":{"type":"string","nullable":true},"hierarchicalSourceEdge":{"type":"string","nullable":true},"hierarchicalSourcePort":{"type":"string","nullable":true},"dstSite":{"type":"string","nullable":true},"destinationEdge":{"type":"string","nullable":true},"destinationPort":{"type":"string","nullable":true},"hierarchicalDestinationEdge":{"type":"string","nullable":true},"hierarchicalDestinationPort":{"type":"string","nullable":true},"bidirectional":{"type":"boolean","nullable":true},"businessStatus":{"type":"string","nullable":true},"networkStatus":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"length":{"type":"number","format":"double","nullable":true},"loss":{"type":"number","format":"double","nullable":true},"ageingLoss":{"type":"number","format":"double","nullable":true},"ageingFactor":{"type":"number","format":"double","nullable":true},"attenuationCoeff":{"type":"number","format":"double","nullable":true},"pmd":{"type":"number","format":"double","nullable":true},"measurementUnits":{"type":"string","nullable":true},"fiberType":{"type":"string","nullable":true},"isOsnrDataValid":{"type":"boolean","nullable":true},"noise":{"type":"number","format":"double","nullable":true},"sigma":{"type":"number","format":"double","nullable":true},"unlocked":{"type":"array","nullable":true,"items":{"type":"string"}},"forced":{"type":"array","nullable":true,"items":{"type":"string"}},"opticalParams":{"type":"object","properties":{"isValid":{"type":"boolean","nullable":true},"noise":{"type":"number","format":"double","nullable":true},"noiseSigma":{"type":"number","format":"double","nullable":true},"chromaticDispersion":{"type":"number","format":"double","nullable":true},"chromaticDispersionSlope":{"type":"number","format":"double","nullable":true},"pdl":{"type":"number","format":"double","nullable":true},"pmd":{"type":"number","format":"double","nullable":true},"fgdrFilters":{"type":"array","nullable":true,"items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"count":{"type":"integer","format":"int32","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/OpticalFilterCounter"}},"sfFilters":{"type":"array","nullable":true,"items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"count":{"type":"integer","format":"int32","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/OpticalFilterCounter"}},"dropPower":{"type":"number","format":"double","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/NCMSOpticalParams"},"channelNumber":{"type":"integer","format":"int32","nullable":true},"pmdCoefficient":{"type":"number","format":"double","nullable":true},"connectorLossIn":{"type":"number","format":"double","nullable":true},"connectorLossOut":{"type":"number","format":"double","nullable":true},"adminState":{"type":"string","nullable":true},"serviceState":{"type":"string","nullable":true},"uid":{"type":"string","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/Fiber"},"unlocked":{"type":"array","nullable":true,"items":{"type":"string"}},"forced":{"type":"array","nullable":true,"items":{"type":"string"}},"omsLink":{"type":"array","nullable":true,"items":{"type":"string"}},"status":{"type":"string","description":"Status of the Topology Fiber Span","nullable":true,"example":"discovered"},"dstIp":{"type":"string","description":"Destination IP for the Fiber Span","nullable":true,"example":"10.64.105.83"},"srcIp":{"type":"string","description":"Source IP for the Fiber Span","nullable":true,"example":"10.64.105.180"},"srcSnmpIndex":{"type":"string","description":"SNMP Index for the source","nullable":true,"example":"2"},"dstSnmpIndex":{"type":"string","description":"SNMP Index for the destination","nullable":true,"example":"2"},"alarmUid":{"uniqueItems":true,"type":"array","description":"Alarm UID list for the FiberSpan","nullable":true,"example":["e9eb0533-a078-33d5-8b88-1d77d352df10","a76302d1-4ae9-359d-87d0-3237be28ef85"],"items":{"type":"string","description":"Alarm UID list for the FiberSpan","example":"[\"e9eb0533-a078-33d5-8b88-1d77d352df10\",\"a76302d1-4ae9-359d-87d0-3237be28ef85\"]"}},"version":{"type":"integer","description":"Version of the Fiber Span","format":"int64","nullable":true,"example":1},"tags":{"type":"array","description":"Tags associated with the Fiber Span","nullable":true,"example":["tag1","tag2"],"items":{"type":"string","description":"Tags associated with the Fiber Span","example":"[\"tag1\",\"tag2\"]"}},"coddesignData":{"type":"object","properties":{"totalDispersion":{"type":"number","format":"double","nullable":true},"totalSpanLoss":{"type":"number","format":"double","nullable":true}},"nullable":true,"$$ref":"#/components/schemas/CODDesignData"},"UID":{"type":"string","description":"Unique ID for the Topology Fiber","nullable":true,"example":"6b195a2f-9acb-31fd-b721-8d659a121537"}},"description":"Response object for Topology Fiber Span section","nullable":true,"example":{"uid":"a91c25f9-5196-3a48-a13b-2a5455acb46e","status":"discovered","src_ip":"10.58.230.76","dst_ip":"10.58.230.74","src_slv_act":"NULL","dst_slv_act":"NULL","src_snmp_index":"NULL","dst_snmp_index":"NULL","hierarchicaluid":"ots_10.58.230.76-3_10.58.230.74-10","label":"ots_Foggia_06-3_Roma_04-10","src_site":"5ac64fde-dbc7-38e5-8f95-0746be78f5ba","dst_site":"b30178e4-8e39-33df-a94a-4fd7497ec630","source_edge":"edgeSide-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-3","destination_edge":"edgeSide-382ac668-b2ab-3b5d-922c-10145d202d39-10","hierarchical_source_edge":"edgeSide-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-3","hierarchical_destination_edge":"edgeSide-382ac668-b2ab-3b5d-922c-10145d202d39-10","l0design_data":{"cdcband":null,"qdcband":null,"rdFactor":null,"cbandRule":null,"isLOGOEnabled":null,"connectorLossIn":null,"lengthBasedLoss":null,"connectorLossOut":null},"bidirectional":true,"business_status":"FUTURE","network_status":"DISCOVERED","admin_state":"UNLOCKED","service_state":"ENABLED","fiber_type":"G652-SMF-28E","length":60,"loss":null,"ageing_loss":"NULL","ageing_factor":"NULL","attenuation_coeff":"NULL","pmd":0,"dcn_extension":"NULL","osc_frame_type":"NULL","raman_amplified":"NULL","measurement_units":"km","src_deviceuid":"a3bf8d4a-355c-3743-945f-a56c2a2d9a50","dst_deviceuid":"382ac668-b2ab-3b5d-922c-10145d202d39","forward":{"pmd":0,"uid":"6eb00447-20fe-3909-b886-518fd799290e","loss":26,"label":"ots_Foggia_06-3_Roma_04-10-COUPLE-AZ","noise":-21.891,"sigma":0.07,"forced":[],"length":100,"dstSite":"b30178e4-8e39-33df-a94a-4fd7497ec630","srcSite":"5ac64fde-dbc7-38e5-8f95-0746be78f5ba","unlocked":[],"fiberType":null,"adminState":"UNLOCKED","ageingLoss":null,"sourceEdge":"edgeSide-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-3","sourcePort":"port-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-1/3/LINE-TX","ageingFactor":null,"dstDeviceUID":"382ac668-b2ab-3b5d-922c-10145d202d39","serviceState":"ENABLED","srcDeviceUID":"a3bf8d4a-355c-3743-945f-a56c2a2d9a50","bidirectional":null,"channelNumber":null,"networkStatus":"DISCOVERED","opticalParams":null,"businessStatus":"FUTURE","pmdCoefficient":0,"connectorLossIn":0,"destinationEdge":"edgeSide-382ac668-b2ab-3b5d-922c-10145d202d39-10","destinationPort":"port-382ac668-b2ab-3b5d-922c-10145d202d39-15/2/LINE-RX","hierarchicalUID":"ots_forward_port-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-1/3/LINE-TX","isOsnrDataValid":false,"attenuationCoeff":null,"connectorLossOut":0,"measurementUnits":"km","hierarchicalSourceEdge":"edgeSide-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-3","hierarchicalSourcePort":"port-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-1/3/LINE-TX","hierarchicalDestinationEdge":"edgeSide-382ac668-b2ab-3b5d-922c-10145d202d39-10","hierarchicalDestinationPort":"port-382ac668-b2ab-3b5d-922c-10145d202d39-15/2/LINE-RX"},"reverse":{"pmd":0.7745966692414834,"uid":"cae5702d-5690-3590-ae3a-ce8bc4eed570","loss":17.3,"label":"ots_Foggia_06-3_Roma_04-10-COUPLE-ZA","noise":-17.359,"sigma":0.164,"forced":[],"length":60,"dstSite":"5ac64fde-dbc7-38e5-8f95-0746be78f5ba","srcSite":"b30178e4-8e39-33df-a94a-4fd7497ec630","unlocked":[],"fiberType":null,"adminState":"UNLOCKED","ageingLoss":null,"sourceEdge":"edgeSide-382ac668-b2ab-3b5d-922c-10145d202d39-10","sourcePort":"port-382ac668-b2ab-3b5d-922c-10145d202d39-15/2/LINE-TX","ageingFactor":null,"dstDeviceUID":"a3bf8d4a-355c-3743-945f-a56c2a2d9a50","serviceState":"ENABLED","srcDeviceUID":"382ac668-b2ab-3b5d-922c-10145d202d39","bidirectional":null,"channelNumber":null,"networkStatus":"DISCOVERED","opticalParams":null,"businessStatus":"FUTURE","pmdCoefficient":0.1,"connectorLossIn":0.2,"destinationEdge":"edgeSide-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-3","destinationPort":"port-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-1/3/LINE-RX","hierarchicalUID":"ots_reverse_port-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-1/3/LINE-TX","isOsnrDataValid":false,"attenuationCoeff":null,"connectorLossOut":0.2,"measurementUnits":"km","hierarchicalSourceEdge":"edgeSide-382ac668-b2ab-3b5d-922c-10145d202d39-10","hierarchicalSourcePort":"port-382ac668-b2ab-3b5d-922c-10145d202d39-15/2/LINE-TX","hierarchicalDestinationEdge":"edgeSide-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-3","hierarchicalDestinationPort":"port-a3bf8d4a-355c-3743-945f-a56c2a2d9a50-1/3/LINE-RX"},"unlocked":[],"forced":[],"coddesign_data":"NULL","version":11,"alarm_uid":[],"oms_link":["da6deb20-76e4-38b0-b8fb-1321c7b7a12a"],"description":"NULL","tags":[]},"$$ref":"#/components/schemas/TopologyFiberSpanSection"}}}},"400":{"description":"Bad Request","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"httpStatus":{"type":"string","nullable":true,"enum":["CONTINUE","SWITCHING_PROTOCOLS","PROCESSING","CHECKPOINT","OK","CREATED","ACCEPTED","NON_AUTHORITATIVE_INFORMATION","NO_CONTENT","RESET_CONTENT","PARTIAL_CONTENT","MULTI_STATUS","ALREADY_REPORTED","IM_USED","MULTIPLE_CHOICES","MOVED_PERMANENTLY","FOUND","MOVED_TEMPORARILY","SEE_OTHER","NOT_MODIFIED","USE_PROXY","TEMPORARY_REDIRECT","PERMANENT_REDIRECT","BAD_REQUEST","UNAUTHORIZED","PAYMENT_REQUIRED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","NOT_ACCEPTABLE","PROXY_AUTHENTICATION_REQUIRED","REQUEST_TIMEOUT","CONFLICT","GONE","LENGTH_REQUIRED","PRECONDITION_FAILED","PAYLOAD_TOO_LARGE","REQUEST_ENTITY_TOO_LARGE","URI_TOO_LONG","REQUEST_URI_TOO_LONG","UNSUPPORTED_MEDIA_TYPE","REQUESTED_RANGE_NOT_SATISFIABLE","EXPECTATION_FAILED","I_AM_A_TEAPOT","INSUFFICIENT_SPACE_ON_RESOURCE","METHOD_FAILURE","DESTINATION_LOCKED","UNPROCESSABLE_ENTITY","LOCKED","FAILED_DEPENDENCY","TOO_EARLY","UPGRADE_REQUIRED","PRECONDITION_REQUIRED","TOO_MANY_REQUESTS","REQUEST_HEADER_FIELDS_TOO_LARGE","UNAVAILABLE_FOR_LEGAL_REASONS","INTERNAL_SERVER_ERROR","NOT_IMPLEMENTED","BAD_GATEWAY","SERVICE_UNAVAILABLE","GATEWAY_TIMEOUT","HTTP_VERSION_NOT_SUPPORTED","VARIANT_ALSO_NEGOTIATES","INSUFFICIENT_STORAGE","LOOP_DETECTED","BANDWIDTH_LIMIT_EXCEEDED","NOT_EXTENDED","NETWORK_AUTHENTICATION_REQUIRED"]}},"nullable":true,"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"400","errorMessage":"There is no resource with UUID=11111111-1111-1111-1111-111111111111","path":"/v1/resource/11111111-1111-1111-1111-111111111111","httpStatus":"BAD_REQUEST"}}}},"404":{"description":"Not Found","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"httpStatus":{"type":"string","nullable":true,"enum":["CONTINUE","SWITCHING_PROTOCOLS","PROCESSING","CHECKPOINT","OK","CREATED","ACCEPTED","NON_AUTHORITATIVE_INFORMATION","NO_CONTENT","RESET_CONTENT","PARTIAL_CONTENT","MULTI_STATUS","ALREADY_REPORTED","IM_USED","MULTIPLE_CHOICES","MOVED_PERMANENTLY","FOUND","MOVED_TEMPORARILY","SEE_OTHER","NOT_MODIFIED","USE_PROXY","TEMPORARY_REDIRECT","PERMANENT_REDIRECT","BAD_REQUEST","UNAUTHORIZED","PAYMENT_REQUIRED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","NOT_ACCEPTABLE","PROXY_AUTHENTICATION_REQUIRED","REQUEST_TIMEOUT","CONFLICT","GONE","LENGTH_REQUIRED","PRECONDITION_FAILED","PAYLOAD_TOO_LARGE","REQUEST_ENTITY_TOO_LARGE","URI_TOO_LONG","REQUEST_URI_TOO_LONG","UNSUPPORTED_MEDIA_TYPE","REQUESTED_RANGE_NOT_SATISFIABLE","EXPECTATION_FAILED","I_AM_A_TEAPOT","INSUFFICIENT_SPACE_ON_RESOURCE","METHOD_FAILURE","DESTINATION_LOCKED","UNPROCESSABLE_ENTITY","LOCKED","FAILED_DEPENDENCY","TOO_EARLY","UPGRADE_REQUIRED","PRECONDITION_REQUIRED","TOO_MANY_REQUESTS","REQUEST_HEADER_FIELDS_TOO_LARGE","UNAVAILABLE_FOR_LEGAL_REASONS","INTERNAL_SERVER_ERROR","NOT_IMPLEMENTED","BAD_GATEWAY","SERVICE_UNAVAILABLE","GATEWAY_TIMEOUT","HTTP_VERSION_NOT_SUPPORTED","VARIANT_ALSO_NEGOTIATES","INSUFFICIENT_STORAGE","LOOP_DETECTED","BANDWIDTH_LIMIT_EXCEEDED","NOT_EXTENDED","NETWORK_AUTHENTICATION_REQUIRED"]}},"nullable":true,"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"404","errorMessage":"The requested resource was not found.","path":"/v1/resources/11111111-1111-1111-1111-111111111111","httpStatus":"NOT_FOUND"}}}},"405":{"description":"Method Not Allowed","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"httpStatus":{"type":"string","nullable":true,"enum":["CONTINUE","SWITCHING_PROTOCOLS","PROCESSING","CHECKPOINT","OK","CREATED","ACCEPTED","NON_AUTHORITATIVE_INFORMATION","NO_CONTENT","RESET_CONTENT","PARTIAL_CONTENT","MULTI_STATUS","ALREADY_REPORTED","IM_USED","MULTIPLE_CHOICES","MOVED_PERMANENTLY","FOUND","MOVED_TEMPORARILY","SEE_OTHER","NOT_MODIFIED","USE_PROXY","TEMPORARY_REDIRECT","PERMANENT_REDIRECT","BAD_REQUEST","UNAUTHORIZED","PAYMENT_REQUIRED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","NOT_ACCEPTABLE","PROXY_AUTHENTICATION_REQUIRED","REQUEST_TIMEOUT","CONFLICT","GONE","LENGTH_REQUIRED","PRECONDITION_FAILED","PAYLOAD_TOO_LARGE","REQUEST_ENTITY_TOO_LARGE","URI_TOO_LONG","REQUEST_URI_TOO_LONG","UNSUPPORTED_MEDIA_TYPE","REQUESTED_RANGE_NOT_SATISFIABLE","EXPECTATION_FAILED","I_AM_A_TEAPOT","INSUFFICIENT_SPACE_ON_RESOURCE","METHOD_FAILURE","DESTINATION_LOCKED","UNPROCESSABLE_ENTITY","LOCKED","FAILED_DEPENDENCY","TOO_EARLY","UPGRADE_REQUIRED","PRECONDITION_REQUIRED","TOO_MANY_REQUESTS","REQUEST_HEADER_FIELDS_TOO_LARGE","UNAVAILABLE_FOR_LEGAL_REASONS","INTERNAL_SERVER_ERROR","NOT_IMPLEMENTED","BAD_GATEWAY","SERVICE_UNAVAILABLE","GATEWAY_TIMEOUT","HTTP_VERSION_NOT_SUPPORTED","VARIANT_ALSO_NEGOTIATES","INSUFFICIENT_STORAGE","LOOP_DETECTED","BANDWIDTH_LIMIT_EXCEEDED","NOT_EXTENDED","NETWORK_AUTHENTICATION_REQUIRED"]}},"nullable":true,"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"405","errorMessage":"The HTTP method used is not allowed for this endpoint.","path":"/v1/resources/11111111-1111-1111-1111-111111111111","httpStatus":"METHOD_NOT_ALLOWED"}}}},"500":{"description":"Internal Server Error","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"httpStatus":{"type":"string","nullable":true,"enum":["CONTINUE","SWITCHING_PROTOCOLS","PROCESSING","CHECKPOINT","OK","CREATED","ACCEPTED","NON_AUTHORITATIVE_INFORMATION","NO_CONTENT","RESET_CONTENT","PARTIAL_CONTENT","MULTI_STATUS","ALREADY_REPORTED","IM_USED","MULTIPLE_CHOICES","MOVED_PERMANENTLY","FOUND","MOVED_TEMPORARILY","SEE_OTHER","NOT_MODIFIED","USE_PROXY","TEMPORARY_REDIRECT","PERMANENT_REDIRECT","BAD_REQUEST","UNAUTHORIZED","PAYMENT_REQUIRED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","NOT_ACCEPTABLE","PROXY_AUTHENTICATION_REQUIRED","REQUEST_TIMEOUT","CONFLICT","GONE","LENGTH_REQUIRED","PRECONDITION_FAILED","PAYLOAD_TOO_LARGE","REQUEST_ENTITY_TOO_LARGE","URI_TOO_LONG","REQUEST_URI_TOO_LONG","UNSUPPORTED_MEDIA_TYPE","REQUESTED_RANGE_NOT_SATISFIABLE","EXPECTATION_FAILED","I_AM_A_TEAPOT","INSUFFICIENT_SPACE_ON_RESOURCE","METHOD_FAILURE","DESTINATION_LOCKED","UNPROCESSABLE_ENTITY","LOCKED","FAILED_DEPENDENCY","TOO_EARLY","UPGRADE_REQUIRED","PRECONDITION_REQUIRED","TOO_MANY_REQUESTS","REQUEST_HEADER_FIELDS_TOO_LARGE","UNAVAILABLE_FOR_LEGAL_REASONS","INTERNAL_SERVER_ERROR","NOT_IMPLEMENTED","BAD_GATEWAY","SERVICE_UNAVAILABLE","GATEWAY_TIMEOUT","HTTP_VERSION_NOT_SUPPORTED","VARIANT_ALSO_NEGOTIATES","INSUFFICIENT_STORAGE","LOOP_DETECTED","BANDWIDTH_LIMIT_EXCEEDED","NOT_EXTENDED","NETWORK_AUTHENTICATION_REQUIRED"]}},"nullable":true,"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"500","errorMessage":"An unexpected error occurred on the server.","path":"/v1/resources/11111111-1111-1111-1111-111111111111","httpStatus":"INTERNAL_SERVER_ERROR"}}}}},"security":[{"basicAuth":[]}],"__originalOperationId":"getOTSinkForUID","method":"get","path":"/v1/otsLinks/{otsLinkUID}"}}