Creates or updates message subscription to statistic values.
In order to form a statisticKey object for this request, a client needs to first retrieve the statististic catalog as well as parameter values.
Null values may be returned in the initial isDelta=false message. The actual values (assuming they are not truly null on the server) will come in a subsequent message as soon as possible. To read more about this process, see Statistics and Alerts.
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 list of statistic keys used to identify a specific statistic value.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 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.
Required
The list of statistic values that have changed.Required
The value to uniquely identify a statistic.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 value type of the statistic.This property can be null.
Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
Required
The JSON type representing this option.Required
Required
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.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.