Operation

get /otn/alarms/all
listAllAlarms (listAllAlarms : /otn/alarms/all)
listAllAlarms


Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

    200success AlarmInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /otn/alarms/correlated/{id}
    listCorrelatedAlarm (listCorrelatedAlarm : /otn/alarms/correlated/{id})
    listCorrelatedAlarm

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

    200success AlarmInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /otn/alarms/correlated/all
    listCorrelatedAlarms (listCorrelatedAlarms : /otn/alarms/correlated/all)
    listCorrelatedAlarms


    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

    200success AlarmInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /otn/alarms/elementary/{id}
    listElementaryAlarm (listElementaryAlarm : /otn/alarms/elementary/{id})
    listElementaryAlarm

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

    200success AlarmInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /otn/alarms/elementary/all
    listElementaryAlarms (listElementaryAlarms : /otn/alarms/elementary/all)
    listElementaryAlarms


    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

    200success AlarmInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    AlarmInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer --- ---
    requestId Long long --- ---
    clientName String string --- ---
    clientLocation String string --- ---
    clientUser String string --- ---
    sessionId String string --- ---
    mdcId String string --- ---
    sequenceNum Integer integer --- ---
    moreToCome Boolean boolean --- ---
    messages array[OtnI18nMessage] OtnI18nMessage --- ---
    errcde String string --- ---
    errorParams array[Object] object --- ---
    nextTasks array[String] string --- ---
    items array[HashMap«string,string»] HashMap«string,string» --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---
    timeout Long long --- ---
    nadString String string --- ---

    HashMap«string,string»

    Name

    Type

    Description

    Enum

    OtnI18nMessage

    Name

    Type

    Description

    Enum

    messageType String string --- [Info, Warning, Error]
    messageUnformatted String string --- ---
    validPropertyResourceMessage Boolean boolean --- ---
    messageId String string --- ---
    messageParams array[String] string --- ---
    messageTime Long long --- ---
    message String string --- ---