Get Custom History Alarms - Cisco Optical Network Controller 25.1.x API

{"type":"api","title":"Get Custom History Alarms","meta":{"id":"/apps/pubhub/media/conc-2511/d77fe2fa1c66c5533550637c8fa49491e06b8c79/8983f23f-480c-340b-8185-aea8987e5cf7","info":{"title":"Alarm Service","description":"Alarm 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":"Alarm API documentation"}],"x-parser-conf":{"overview":{"markdownPath":"reference/2431/alarmservice.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-alarm-service","description":"Generated server url"}],"securitySchemes":{"basicAuth":{"type":"http","description":"Basic authentication scheme","scheme":"basic"}}},"spec":{"tags":["Alarm API documentation"],"summary":"Get Custom History Alarms","description":"Get the entire unique history/tca alarms data for specified time","operationId":"getCustomHistoryAlarms","parameters":[{"name":"startTime","in":"query","description":"starting time to get the alarm history","required":true,"schema":{"type":"string","nullable":true}},{"name":"endTime","in":"query","description":"ending time to get the alarm history","required":true,"schema":{"type":"string","nullable":true}}],"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":{"*/*":{"schema":{"type":"array","items":{"type":"object","description":"Response object representing historical TCA alarm details.","properties":{"uid":{"type":"string","format":"uuid","description":"Uid of history alarm","example":"2502571a-084f-38a0-a69f-d8bbacd27eb9","nullable":true},"severity":{"type":"string","description":"Severity of alarm","example":"critical","nullable":true},"alarmTime":{"type":"string","description":"Timestamp of alarm raised/cleared","example":"2025-01-22 00:00:00.001+00","nullable":true},"deviceId":{"type":"string","format":"uuid","description":"DeviceId on which alarm raised","example":"3502571a-084f-38a0-a69f-d8bbacd27eb9","nullable":true},"deviceName":{"type":"string","description":"Device Name on which alarm raised","example":"R1","nullable":true},"alarmId":{"type":"string","format":"uuid","description":"Uid of alarm","example":"8502571a-084f-38a0-a69f-d8bbacd27eb9","nullable":true},"location":{"type":"string","description":"Location on which alarm raised","example":"NEAR","nullable":true},"alarmName":{"type":"string","description":"Name of the alarm","example":"LOS","nullable":true},"alarmInterface":{"type":"string","description":"Interface on which alarm was raised","example":"port","nullable":true},"hostName":{"type":"string","description":"Hostname of the device where alarm was raised","example":"R1","nullable":true},"alarmObjectId":{"type":"string","description":"Object id of alarm on the device","example":"DEVICE: site1","nullable":true},"alarmDirection":{"type":"string","description":"Direction of alarm (e.g. RX, TX, NA)","example":"NA","nullable":true},"alarmDescription":{"type":"string","description":"Detailed description of the alarm","example":"LOS","nullable":true},"alarmSource":{"type":"string","description":"IP of the Node where alarm is raised","example":"10.58.229.218","nullable":true},"serviceAffect":{"type":"string","description":"Service affected by the alarm (SA/NSA)","example":"NSA","nullable":true},"eventId":{"type":"integer","format":"int64","description":"Event id of the alarm","example":778,"nullable":true},"referenceId":{"type":"integer","format":"int64","description":"Reference id correlated with the event id","example":789,"nullable":true},"swVersion":{"type":"string","description":"Software version on which the alarm was raised","example":"25.1.1","nullable":true},"nodeLevelUserTag":{"type":"string","description":"Node‑level user tag assigned to this alarm","example":"LAB#2ROOM#1ROW#A","nullable":true},"alarmCategory":{"type":"string","description":"Category of the alarm","example":"OPTICAL","nullable":true},"transient":{"type":"boolean","description":"Indicates if the alarm is transient","example":false,"nullable":true}},"example":{"uid":"2502571a-084f-38a0-a69f-d8bbacd27eb9","severity":"critical","alarmTime":"2025-01-22 00:00:00.001+00","deviceId":"3502571a-084f-38a0-a69f-d8bbacd27eb9","deviceName":"R1","alarmId":"8502571a-084f-38a0-a69f-d8bbacd27eb9","location":"NEAR","alarmName":"LOS","alarmInterface":"port","hostName":"R1","alarmObjectId":"DEVICE: site1","alarmDirection":"NA","alarmDescription":"LOS","alarmSource":"10.58.229.218","serviceAffect":"NSA","eventId":778,"referenceId":789,"swVersion":"25.1.1","nodeLevelUserTag":"LAB#2ROOM#1ROW#A","alarmCategory":"OPTICAL","transient":false},"$$ref":"#/components/schemas/HistoryAlarmResponse"}}}}},"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","nullable":true},"errorMessage":{"type":"string","description":"Detailed human-readable error message","nullable":true},"path":{"type":"string","description":"Path of the request that caused the error","nullable":true},"httpStatus":{"type":"string","description":"HTTP status associated with the error","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"]}},"description":"Error Detail is the format in which errors are returned ","example":{"errorCode":"400","errorMessage":"Start time must be before end time.","path":"/v1/node/e0d114f6-29d7-3bce-b565-f0202b471f63/alarm-history","httpStatus":"BAD_REQUEST"},"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"400","errorMessage":"Bad Request","path":"/v1/custom-history-alarms","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","nullable":true},"errorMessage":{"type":"string","description":"Detailed human-readable error message","nullable":true},"path":{"type":"string","description":"Path of the request that caused the error","nullable":true},"httpStatus":{"type":"string","description":"HTTP status associated with the error","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"]}},"description":"Error Detail is the format in which errors are returned ","example":{"errorCode":"400","errorMessage":"Start time must be before end time.","path":"/v1/node/e0d114f6-29d7-3bce-b565-f0202b471f63/alarm-history","httpStatus":"BAD_REQUEST"},"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"404","errorMessage":"Not Found","path":"/v1/custom-history-alarms","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","nullable":true},"errorMessage":{"type":"string","description":"Detailed human-readable error message","nullable":true},"path":{"type":"string","description":"Path of the request that caused the error","nullable":true},"httpStatus":{"type":"string","description":"HTTP status associated with the error","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"]}},"description":"Error Detail is the format in which errors are returned ","example":{"errorCode":"400","errorMessage":"Start time must be before end time.","path":"/v1/node/e0d114f6-29d7-3bce-b565-f0202b471f63/alarm-history","httpStatus":"BAD_REQUEST"},"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"405","errorMessage":"Method Not Allowed","path":"/v1/custom-history-alarms","httpStatus":"405 METHOD_NOT_ALLOWED"}}}},"413":{"description":"Payload Too Large","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","nullable":true},"errorMessage":{"type":"string","description":"Detailed human-readable error message","nullable":true},"path":{"type":"string","description":"Path of the request that caused the error","nullable":true},"httpStatus":{"type":"string","description":"HTTP status associated with the error","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"]}},"description":"Error Detail is the format in which errors are returned ","example":{"errorCode":"400","errorMessage":"Start time must be before end time.","path":"/v1/node/e0d114f6-29d7-3bce-b565-f0202b471f63/alarm-history","httpStatus":"BAD_REQUEST"},"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"413","errorMessage":"Payload Too Large","path":"/v1/custom-history-alarms","httpStatus":"413 PAYLOAD_TOO_LARGE"}}}},"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","nullable":true},"errorMessage":{"type":"string","description":"Detailed human-readable error message","nullable":true},"path":{"type":"string","description":"Path of the request that caused the error","nullable":true},"httpStatus":{"type":"string","description":"HTTP status associated with the error","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"]}},"description":"Error Detail is the format in which errors are returned ","example":{"errorCode":"400","errorMessage":"Start time must be before end time.","path":"/v1/node/e0d114f6-29d7-3bce-b565-f0202b471f63/alarm-history","httpStatus":"BAD_REQUEST"},"$$ref":"#/components/schemas/ErrorDetail"},"example":{"errorCode":"500","errorMessage":"Internal Server Error","path":"/v1/custom-history-alarms","httpStatus":"500 INTERNAL_SERVER_ERROR"}}}}},"security":[{"basicAuth":[]}],"__originalOperationId":"getCustomHistoryAlarms","method":"get","path":"/v1/custom-history-alarms"}}