/icws/{sessionId}/messaging/subscriptions/alerts/alert-notifications

PUT

/icws/{sessionId}/messaging/subscriptions/alerts/alert-notifications

Creates or updates watch subscription to alert notifications.

Due to a known issue, the implementation of the subscriptions for the alert catalog and alert notifications are entwined. A request to start the subscription for the alert catalog will implicitly start a subscription for the alert notifications within that catalog. Inversely, calling DELETE on either subscription will stop the other subscription. It is recommended that conusmers of these APIs create subscriptions to the alert catalog followed by the alert notifications as if they are separate to ensure the correct behavior when the known issue is resolved. API consumers should also stop subscriptions to both but should only do so when neither subscription is needed.

Feature Version
statistics 1

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Representations
        alertNotificationSubscription
        Members alertSetsAdded and alertSetsRemoved are both optional, however one is required for a valid subscription request.
        Property
        Value
        Comments
        alertSetId
        String

        Required

        Response

        200 - OK

        The watch subscription to alert notifications has been updated.

        Associated Message
        One or more alert notifications have been triggered and are contained in this message.
        alertNotificationMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:alerts:alertNotificationMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        Required

        When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

        When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

        alertDefinitionId
        String

        Required

        Gets the ID of the AlertDefinition assoicated with this notifiction.
        alertRuleId
        String

        Required

        Gets the ID of the AlertRule that the alert was raised on.
        cleared
        Boolean

        Required

        Gets a value indicating whether this AlertNotification is cleared.
        timeStamp
        DateTime

        Required

        Gets the received date and time.
        statisticIdentifier
        String

        Required

        Gets the statistic defintion.
        parameterTypeId
        String

        Required

        This member needs to match the ID of a parameter type exactly.
        value
        String

        Required

        This member either needs to match a parameter value exactly or be set to an empty string to use a default value.

        Multiple options:

        The value can be assigned any of the following options.
        __type
        "urn:inin.com:statistics:statisticBoolValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Boolean

        Required

        __type
        "urn:inin.com:statistics:statisticDoubleValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Double

        Required

        __type
        "urn:inin.com:statistics:statisticDurationValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Duration

        Required

        __type
        "urn:inin.com:statistics:statisticErrorValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        malformedStatisticKey
        1
        unknownStatisticKey
        2
        statisticProviderTooBusy
        3
        other
        99
        __type
        "urn:inin.com:statistics:statisticFiniteDurationValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        stoppedTimeSpan
        Duration
        startTickingTime
        DateTime
        ticking
        Boolean

        Required

        __type
        "urn:inin.com:statistics:statisticFutureDurationValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Duration

        Required

        __type
        "urn:inin.com:statistics:statisticIntValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Int

        Required

        __type
        "urn:inin.com:statistics:statisticPercentValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Double

        Required

        __type
        "urn:inin.com:statistics:statisticStatusMessageKeyValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        DateTime

        Required

        __type
        "urn:inin.com:statistics:statisticStringValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        String

        Required

        __type
        "urn:inin.com:statistics:statisticTimeDurationValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        DateTime

        Required

        __type
        "urn:inin.com:statistics:statisticTimeStampValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        DateTime

        Required

        400 - Bad Request
        The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
        error
        Provides additional detail for an error.
        Property
        Value
        Comments
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        401 - Unauthorized
        The specified session token is missing, invalid, or has expired.
        Parameters
        Type
        Name
        Comments
        Header
        WWW-Authenticate

        Required

        Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

        WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          410 - Gone
          This resource has been deprecated and removed from the API.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          500 - Internal Server Error
          An unexpected error occurred while processing the request.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.

          DELETE

          /icws/{sessionId}/messaging/subscriptions/alerts/alert-notifications

          Removes watch subscription to alert notifications.

          Due to a known issue, the implementation of the subscriptions for the alert catalog and alert notifications are entwined. A request to start the subscription for the alert catalog will implicitly start a subscription for the alert notifications within that catalog. Inversely, calling DELETE on either subscription will stop the other subscription. It is recommended that conusmers of these APIs create subscriptions to the alert catalog followed by the alert notifications as if they are separate to ensure the correct behavior when the known issue is resolved. API consumers should also stop subscriptions to both but should only do so when neither subscription is needed.

          Feature Version
          statistics 1

          Request

          Parameters
          Type
          Name
          Comments
          Header
          ININ-ICWS-CSRF-Token

          Required

          The ININ session token necessary for all calls that require a security or user context.

            Header
            Cookie

            Required

            The session cookie. With the exception of the connection request, all requests must provide a session cookie.

              Template
              sessionId

              Required

              The ININ session ID necessary for all calls that require a security or user context.

                Response

                204 - No Content
                The watch subscription to alert notifications has been removed.
                400 - Bad Request
                The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
                error
                Provides additional detail for an error.
                Property
                Value
                Comments
                errorId
                String
                The error identifier that describes the current error.
                message
                String

                Required

                A message that describes the current error.
                401 - Unauthorized
                The specified session token is missing, invalid, or has expired.
                Parameters
                Type
                Name
                Comments
                Header
                WWW-Authenticate

                Required

                Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

                WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

                  error
                  Provides additional detail for an error.
                  Property
                  Value
                  Comments
                  errorId
                  String
                  The error identifier that describes the current error.
                  message
                  String

                  Required

                  A message that describes the current error.
                  410 - Gone
                  This resource has been deprecated and removed from the API.
                  error
                  Provides additional detail for an error.
                  Property
                  Value
                  Comments
                  errorId
                  String
                  The error identifier that describes the current error.
                  message
                  String

                  Required

                  A message that describes the current error.
                  500 - Internal Server Error
                  An unexpected error occurred while processing the request.
                  error
                  Provides additional detail for an error.
                  Property
                  Value
                  Comments
                  errorId
                  String
                  The error identifier that describes the current error.
                  message
                  String

                  Required

                  A message that describes the current error.