Creates or updates watch subscription to the alert catalog.
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 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
Required
The JSON type representing this option.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.
Property type documentation:
A list of alert sets.
List item type documentation:
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.
Required
The JSON type representing this option.Required
The alert set access mode.Required
Gets the owner of the alert set.Required
A list of alert definitions.Property type documentation:
A list of alert definitions.
List item type documentation:
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.
Required
The JSON type representing this option.The ID for the alert definition. This parameter should be defined for update operations.
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.
Required
A value indicating whether this instance is editable.Required
The statistic key that is defined for this AlertDefinition.Required
Gets the statistic defintion.Required
The set of parameter value items for the statistic key.This property is required to exist with an empty array if it contains no members. For a statistic key to be valid, all of the parameter types for a statistic key must be used, and they must be presented in the same order they are given in the statistic catalog. Each statistic key will uniquely identify a singular statistic on a single entity, for example the number of available agents on a single workgroup or user. As a result, a new statistic identifer will need to be created for each new pair of statistic and entity that is wanting to be tracked.
Required
This member needs to match the ID of a parameter type exactly.Required
This member either needs to match a parameter value exactly or be set to an empty string to use a default value.Required
The alert rules.List item type documentation:
An alert rule is defined by a circumstance (AlertCondition) that tiggers the rule and the set of outcomes (AlertAction) that occur when the rule is triggered. A collection of alerts rules make up an AlertDefinition.
Required
The JSON type representing this option.Required
The rule actions.List item type documentation:
Represents an alert action specification. An alert action defines what will occur when an alert tiggers. An AlertRule has a list of AlertAction objects that define the behavior of the resulting events.
Gets the action ID. This parameter should be defined for update operations.
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.
Required
A value indicating whether this instance is editable.Required
The target ID who the alert action is destined for.Required
Values based on the selected alerting action.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.The ID for the Alert Rule. This parameter should be defined for update operations.
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.
Required
The alert severity.Required
A value indicating whether this instance is editable.Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.Required
Required
The JSON type representing this option.Required
Required
Required
Required
The JSON type representing this option.Required
Required
Required
Required
The JSON type representing this option.Required
Required
Required
Required
The JSON type representing this option.Required
Required
Required
Required
The JSON type representing this option.Required
Required
Required
The ID of the alert set.
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.
Required
Date and time the alert set was created.Required
Gets the display name of the owner of the alert set.Required
Date and time the alert set was modified.Required
The name of the user who last modified the alert set.Property type documentation:
A list of alert sets.
List item type documentation:
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.
Required
A message that describes the current error.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"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.Removes watch subscription to the alert catalog.
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 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
A message that describes the current error.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"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.