| 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
If the value of a parameterValueItem is set to an empty string, the default will be to retrieve or validate all parameter values for the specified parameterTypeId.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
Required
Required
If the value of a parameterValueItem is set to an empty string, the default will be to retrieve or validate all parameter values for the specified parameterTypeId.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
Required
This is the parameterTypeId.Required
Multiple options:
The value can be assigned any of the following options.Required
A possible value for the parameter.Required
A user friendly string for display purposes.Required
The description for the parameter value.Required
The JSON type representing this option.Required
A possible value for the parameter.Required
A user friendly string for display purposes.Required
The description for the parameter value.Required
The ID of the parameter type.Property type documentation:
Represents a collection of strings.
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.