/icws/{sessionId}/alerts/alert-catalog/alert-sets/{alertSetId}

PUT

/icws/{sessionId}/alerts/alert-catalog/alert-sets/{alertSetId}

Update an existing alert set.
Feature Version
statistics 7

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.

        Template
        alertSetId

        Required

        The ID of the AlertSet resource.

          Representations
          updateAlertSetParameters
          Represents a set of AlertDefinition objects. An alert set contains a group of alerts (AlertDefinition) as well as information about the overall alert set. Use AlertCatalog to manage alert sets.
          Property
          Value
          Comments
          __type
          "urn:inin.com:alerts:updateAlertSetParameters"

          Required

          The JSON type representing this option.
          none
          0
          Access mode has not been set.
          ownerDefault
          1
          Access to the owner's default alert set.
          owned
          2
          Access as an owned alert set.
          shared
          3
          Other users may access and subscribe to the alert set in a read-only manner.
          subscribed
          4
          Indicates whether the alert set is currently subscribed to.
          description
          String
          The description.
          displayString
          String
          The display string.
          owner
          String

          Required

          Gets the owner of the alert set.
          __type
          "urn:inin.com:alerts:alertDefinitionRequest"

          Required

          The JSON type representing this option.
          alertDefinitionId
          String

          The ID for the alert definition. This parameter should be defined for update operations.

          Note

          The alertDefinitionId represents a string formatted GUID. If an alertDefintionId is not provided a GUID ID will be automicatlly generated as the alert definition is updated.

          description
          String
          The description.
          displayString
          String
          The display string.
          isEditable
          Boolean

          Required

          A value indicating whether this instance is editable.
          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.
          __type
          "urn:inin.com:alerts:alertRuleRequest"

          Required

          The JSON type representing this option.
          alertActionId
          String

          Gets the action ID. This parameter should be defined for update operations.

          Note

          The alertActionId represents a string formatted GUID. If an alertActionId is not provided a GUID ID will be automicatlly generated as the alert action is updated.

          isEditable
          Boolean

          Required

          A value indicating whether this instance is editable.
          targetId
          String

          Required

          The target ID who the alert action is destined for.
          [key]
          String

          Required

          The key identifying this pair.
          [value]
          String

          Required

          The value of this pair.
          alertRuleId
          String

          The ID for the Alert Rule. This parameter should be defined for update operations.

          Note

          The alertRuleId represents a string formatted GUID. If an alertRuleId is not provided a GUID ID will be automicatlly generated as the alert rule is updated.

          none
          0
          Alert severity is not set.
          normal
          1
          The status of the resource is normal.
          minor
          2
          An alert level that indicates a problem of relatively low severity that should not impede use of the resource.
          major
          3
          An alert level that indicates some kind of possibly service-affecting problem with the resource. The severity of the problem is relatively high and normal use of the resource is likely to be impaired.
          warning
          4
          An alert level that indicates a condition exists that could potentially cause a problem with the resource.
          critical
          5
          An alert level that indicates a severe problem exists with the resource and normal use is disrupted or severely impeded. This is the most severe alarm level.
          isEditable
          Boolean

          Required

          A value indicating whether this instance is editable.

          Multiple options:

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

          Required

          The JSON type representing this option.
          alertConditionId
          String
          unknown
          0
          Represents the condition has not been specified yet.
          isNotAvailable
          1
          Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
          isAvailable
          2
          Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
          isTrue
          3
          Represents a condition where the boolean value is expected to be true (True in Visual Basic).
          isFalse
          4
          Represents a condition where the boolean value is expected to be false (False in Visual Basic).
          __type
          "urn:inin.com:alerts:numericDoubleConditionRequest"

          Required

          The JSON type representing this option.
          alertConditionId
          String
          unknown
          0
          Represents the condition has not been specified yet.
          isNotAvailable
          1
          Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
          isAvailable
          2
          Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
          isLessThan
          3
          Represents a condition where the numeric value is expected to be less than the minimum.
          isGreaterThan
          4
          Represents a condition where the numeric value is expected to be greater than the maximum.
          range
          5
          Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
          minimum
          Double
          maximum
          Double
          __type
          "urn:inin.com:alerts:numericIntConditionRequest"

          Required

          The JSON type representing this option.
          alertConditionId
          String
          unknown
          0
          Represents the condition has not been specified yet.
          isNotAvailable
          1
          Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
          isAvailable
          2
          Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
          isLessThan
          3
          Represents a condition where the numeric value is expected to be less than the minimum.
          isGreaterThan
          4
          Represents a condition where the numeric value is expected to be greater than the maximum.
          range
          5
          Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
          minimum
          Int
          maximum
          Int
          __type
          "urn:inin.com:alerts:numericTimeSpanConditionRequest"

          Required

          The JSON type representing this option.
          alertConditionId
          String
          unknown
          0
          Represents the condition has not been specified yet.
          isNotAvailable
          1
          Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
          isAvailable
          2
          Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
          isLessThan
          3
          Represents a condition where the numeric value is expected to be less than the minimum.
          isGreaterThan
          4
          Represents a condition where the numeric value is expected to be greater than the maximum.
          range
          5
          Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
          minimum
          Duration
          maximum
          Duration
          __type
          "urn:inin.com:alerts:numericTimeStampConditionRequest"

          Required

          The JSON type representing this option.
          alertConditionId
          String
          unknown
          0
          Represents the condition has not been specified yet.
          isNotAvailable
          1
          Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
          isAvailable
          2
          Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
          isLessThan
          3
          Represents a condition where the numeric value is expected to be less than the minimum.
          isGreaterThan
          4
          Represents a condition where the numeric value is expected to be greater than the maximum.
          range
          5
          Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
          minimum
          DateTime
          maximum
          DateTime
          __type
          "urn:inin.com:alerts:stringConditionRequest"

          Required

          The JSON type representing this option.
          alertConditionId
          String
          unknown
          0
          Represents the condition has not been specified yet.
          isNotAvailable
          1
          Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
          isAvailable
          2
          Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
          equalTo
          3
          Represents a condition where a StatisticValue string value is equal to the comparison value.
          notEqualTo
          4
          Represents a condition where a StatisticValue string value is not equal to the comparison value.
          contains
          5
          Represents a condition where a StatisticValue string value contains the comparison value.
          doesNotContain
          6
          Represents a condition where a StatisticValue string value does not contain the comparison value.
          matchesPrefix
          7
          Represents a condition where a StatisticValue string value matches the prefix.
          text
          String
          alertSetId
          String

          Required

          The ID of the alert set.

          Note

          The alertSetId represents a string formatted GUID. Any attempt to provide a string that does not represent a GUID will cause a 400 status code to be returned.

          Response

          200 - OK
          The alert set was updated.
          403 - Forbidden
          The session user does not have rights to create alert sets.
          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.
          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}/alerts/alert-catalog/alert-sets/{alertSetId}

            Deletes a specific alert set.
            Feature Version
            statistics 7

            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.

                  Template
                  alertSetId

                  Required

                  The ID of the AlertSet resource.

                    Response

                    200 - OK
                    The alert set has been removed.
                    404 - Not Found
                    The alert set does not exist.
                    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.
                    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.