Interaction Center Web Services (ICWS)

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

Feature	Version	Obsolete Version
statistics	7

POST

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

Creates a new alert set.

Feature	Version	Obsolete 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

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

createAlertSetParameters

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.

Expand All Collapse All

Property

Value

Comments

__type

"urn:inin.com:alerts:createAlertSetParameters"

Required

The JSON type representing this option.

accessMode

Enumeration: alertSetAccessMode

Required

The alert set access mode.

none

Access mode has not been set.

ownerDefault

Access to the owner's default alert set.

owned

Access as an owned alert set.

shared

Other users may access and subscribe to the alert set in a read-only manner.

subscribed

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.

alertDefinitions

List [Unbounded]: Complex Type: alertDefinitionRequest

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.

__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.

statisticKey

Complex Type: statisticKey

Required

The statistic key that is defined for this AlertDefinition.

statisticIdentifier

String

Required

Gets the statistic defintion.

parameterValueItems

List [Unbounded]: Complex Type: parameterValueItem

Required

The set of parameter value items for the statistic key.

Note

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.

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.

alertRules

List [Unbounded]: Complex Type: alertRuleRequest

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.

__type

"urn:inin.com:alerts:alertRuleRequest"

Required

The JSON type representing this option.

alertActions

List [Unbounded]: Complex Type: alertAction

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.

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.

namedValues

Dictionary

Required

Values based on the selected alerting action.

Property type documentation:

Represents a collection of key/value string pairs.

[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.

alertSeverity

Enumeration: alertSeverity

Required

The alert severity.

none

Alert severity is not set.

normal

The status of the resource is normal.

minor

An alert level that indicates a problem of relatively low severity that should not impede use of the resource.

major

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

An alert level that indicates a condition exists that could potentially cause a problem with the resource.

critical

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.

alertCondition

Multiple Options: alertConditionRequest

The rule condition.

Multiple options:

The value can be assigned any of the following options.

[option]

Complex Type: boolConditionRequest

Represents a boolean alert condition. This condition can be used on boolean statistics to trigger if the value is true or false, or if the statistics is or is not available. To create a new BoolCondition use one of the static Create functions.

__type

"urn:inin.com:alerts:boolConditionRequest"

Required

The JSON type representing this option.

alertConditionId

String

alertConditionComparison

Enumeration: booleanAlertConditionComparison

Required

unknown

Represents the condition has not been specified yet.

isNotAvailable

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

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

Represents a condition where the boolean value is expected to be true (True in Visual Basic).

isFalse

Represents a condition where the boolean value is expected to be false (False in Visual Basic).

[option]

Complex Type: numericDoubleConditionRequest

Represents a numeric double alert condition. A numeric double condition can be used against double statistics to create alerts that trigger when the statistic is greater than, less then, between, equal to, or not equal to the supplied values, or if the statistic is or is not available. To create a new NumericDoubleCondition use one of the static Create functions.

__type

"urn:inin.com:alerts:numericDoubleConditionRequest"

Required

The JSON type representing this option.

alertConditionId

String

alertConditionComparison

Enumeration: numericAlertConditionComparison

Required

unknown

Represents the condition has not been specified yet.

isNotAvailable

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

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

Represents a condition where the numeric value is expected to be less than the minimum.

isGreaterThan

Represents a condition where the numeric value is expected to be greater than the maximum.

range

Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).

minimum

Double

maximum

Double

[option]

Complex Type: numericIntConditionRequest

Represents a numeric integer alert condition. A numeric int condition can be used against integer statistics to create alerts that trigger when the statistic is greater than, less then, between, equal to, or not equal to the supplied values, or if the statistic is or is not available. To create a new NumericIntCondition use one of the static Create functions.

__type

"urn:inin.com:alerts:numericIntConditionRequest"

Required

The JSON type representing this option.

alertConditionId

String

alertConditionComparison

Enumeration: numericAlertConditionComparison

Required

unknown

Represents the condition has not been specified yet.

isNotAvailable

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

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

Represents a condition where the numeric value is expected to be less than the minimum.

isGreaterThan

Represents a condition where the numeric value is expected to be greater than the maximum.

range

Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).

minimum

Int

maximum

Int

[option]

Complex Type: numericTimeSpanConditionRequest

Represents a numeric time span alert condition. A numeric time span condition can be used against time span statistics to create alerts that trigger when the statistic is greater than, less then, between, equal to, or not equal to the supplied values, or if the statistic is or is not available. To create a new NumericTimeSpanCondition use one of the static Create functions.

__type

"urn:inin.com:alerts:numericTimeSpanConditionRequest"

Required

The JSON type representing this option.

alertConditionId

String

alertConditionComparison

Enumeration: numericAlertConditionComparison

Required

unknown

Represents the condition has not been specified yet.

isNotAvailable

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

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

Represents a condition where the numeric value is expected to be less than the minimum.

isGreaterThan

Represents a condition where the numeric value is expected to be greater than the maximum.

range

Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).

minimum

Duration

maximum

Duration

[option]

Complex Type: numericTimeStampConditionRequest

Represents a numeric time stamp alert condition. A numeric time stamp condition can be used against time stamp statistics to create alerts that trigger when the statistic is greater than, less then, between, equal to, or not equal to the supplied values, or if the statistic is or is not available. To create a new NumericTimeStampCondition use one of the static Create functions.

__type

"urn:inin.com:alerts:numericTimeStampConditionRequest"

Required

The JSON type representing this option.

alertConditionId

String

alertConditionComparison

Enumeration: numericAlertConditionComparison

Required

unknown

Represents the condition has not been specified yet.

isNotAvailable

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

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

Represents a condition where the numeric value is expected to be less than the minimum.

isGreaterThan

Represents a condition where the numeric value is expected to be greater than the maximum.

range

Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).

minimum

DateTime

maximum

DateTime

[option]

Complex Type: stringConditionRequest

Represents a string alert condition. A string condition can be used against string statistics to create alerts that trigger when the statistic has a value that matches, contains, or does not contain the supplied text, or if the statistic is or is not available. To create a new StringCondition use one of the static Create functions.

__type

"urn:inin.com:alerts:stringConditionRequest"

Required

The JSON type representing this option.

alertConditionId

String

alertConditionComparison

Enumeration: stringAlertConditionComparison

Required

unknown

Represents the condition has not been specified yet.

isNotAvailable

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

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

Represents a condition where a StatisticValue string value is equal to the comparison value.

notEqualTo

Represents a condition where a StatisticValue string value is not equal to the comparison value.

contains

Represents a condition where a StatisticValue string value contains the comparison value.

doesNotContain

Represents a condition where a StatisticValue string value does not contain the comparison value.

matchesPrefix

Represents a condition where a StatisticValue string value matches the prefix.

text

String

Response

201 - Created

The alert set was created.

alertSetCreated

Expand All Collapse All

Property

Value

Comments

alertSetId

String

Required

The created alert set's ID.

403 - Forbidden

The session user does not have rights to create alert sets.

error

Provides additional detail for an error.

Expand All Collapse All

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.

Expand All Collapse All

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.

Expand All Collapse All

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.

Expand All Collapse All

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.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.