Get OMSLink data from Site UIDs - Cisco Optical Network Controller 25.1.2 API

{"type":"api","title":"Get OMSLink data from Site UIDs","meta":{"id":"/apps/pubhub/media/conc-2512/e4127924420206b51a12ca369b8fc51519653b60/2d61b433-8d34-3d12-9cef-f2aa9914670a","info":{"title":"OSAPI-GW Service","description":"OSAPI-GW service api documentation","contact":{},"version":"1.0.0-25.1.2"},"security":[{"basicAuth":[]}],"tags":[{"name":"Topology API documentation"},{"name":"Export API documentation for External"},{"name":"Network API documentation"},{"name":"Inventory API documentation"},{"name":"Circuit API documentation"}],"x-parser-conf":{"overview":{"markdownPath":"reference/osapi-gw.md"}},"openapi":"3.0.1","servers":[{"url":"https://cisco-onc-ip:8443/onc-osapi-gw-service/","description":"API Server"}],"securitySchemes":{"basicAuth":{"type":"http","description":"Basic authentication scheme","scheme":"basic"}}},"spec":{"tags":["Network API documentation"],"summary":"Get OMSLink data from Site UIDs","description":"Get OMSLink data from Site UIDs\n\n**Curl Example:** `curl -k -u username:password -X GET 'https://cisco-onc-ip:8443/onc-osapi-gw-service/[endpoint]'`","operationId":"getOMSLinksByDeviceUIDs","parameters":[{"name":"siteUIDs","in":"query","description":"List of site uids","required":true,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}],"responses":{"200":{"description":"Retrieved the Object successfully","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":{"entityPath":{"type":"string"},"data":{"type":"object"}},"$$ref":"#/components/schemas/NodePayload"},"example":{"entityPath":"/network/site-uid-1234","data":{"linkType":"fiber","status":"active","latency":12.3,"bandwidth":"1Gbps"}}}}},"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":{"*/*":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code representing the specific error","example":"400"},"errorMessage":{"type":"string","description":"Detailed human-readable error message","example":"There is no OMS link with UUID=2502571a-084f-38a0-a69f-d8bbacd27eb9"},"path":{"type":"string","description":"Path of the request that caused the error","example":"/v1/oms-links/2502571a-084f-38a0-a69f-d8bbacd27eb9"},"httpStatus":{"type":"string","description":"HTTP status associated with the error","example":"400 BAD_REQUEST","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}},"$$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":"400 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":{"*/*":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code representing the specific error","example":"400"},"errorMessage":{"type":"string","description":"Detailed human-readable error message","example":"There is no OMS link with UUID=2502571a-084f-38a0-a69f-d8bbacd27eb9"},"path":{"type":"string","description":"Path of the request that caused the error","example":"/v1/oms-links/2502571a-084f-38a0-a69f-d8bbacd27eb9"},"httpStatus":{"type":"string","description":"HTTP status associated with the error","example":"400 BAD_REQUEST","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}},"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"404","errorMessage":"The requested resource was not found.","path":"/v1/resources/11111111-1111-1111-1111-111111111111","httpStatus":"404 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":{"*/*":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code representing the specific error","example":"400"},"errorMessage":{"type":"string","description":"Detailed human-readable error message","example":"There is no OMS link with UUID=2502571a-084f-38a0-a69f-d8bbacd27eb9"},"path":{"type":"string","description":"Path of the request that caused the error","example":"/v1/oms-links/2502571a-084f-38a0-a69f-d8bbacd27eb9"},"httpStatus":{"type":"string","description":"HTTP status associated with the error","example":"400 BAD_REQUEST","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}},"$$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":"405 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":{"*/*":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code representing the specific error","example":"400"},"errorMessage":{"type":"string","description":"Detailed human-readable error message","example":"There is no OMS link with UUID=2502571a-084f-38a0-a69f-d8bbacd27eb9"},"path":{"type":"string","description":"Path of the request that caused the error","example":"/v1/oms-links/2502571a-084f-38a0-a69f-d8bbacd27eb9"},"httpStatus":{"type":"string","description":"HTTP status associated with the error","example":"400 BAD_REQUEST","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}},"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"500","errorMessage":"An unexpected error occurred on the server.","path":"/v1/resources/11111111-1111-1111-1111-111111111111","httpStatus":"500 INTERNAL_SERVER_ERROR"}}}}},"security":[{"basicAuth":[]}],"__originalOperationId":"getOMSLinksByDeviceUIDs","method":"get","path":"/v1/network-entities/oms-link-data"}}