| Feature | Version | |
|---|---|---|
| configuration | 11 |
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
The ID of the subscription.Required
The Security Right to use with the watch. The values that can be used with this are found on the rightsFilter query parameter of the GET operation for this object type.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
Property type documentation:
Represents the loginAuthentication configuration object.
Setting this property to null will set it to its default value.
Default value: false
Setting this property to null will set it to its default value.
Default value: false
Setting this property to null will set it to its default value.
Default value: false
Setting this property to null will set it to its default value.
Default value: false
Setting this property to null will set it to its default value.
Default value: false
| Feature | Version | |
|---|---|---|
| configuration | 8 |
This property can be null.
Property type documentation:
Represents a property that can have values for multiple languages. The list of supported languages can be obtained from /configuration/system/languages resource. If a non-supported language is used then language fallback logic will not work. In order to clear a value for any language, it must be explicitly set to null.
List item type documentation:
Represents a multi-language property value.
Required
Required
| Feature | Version | |
|---|---|---|
| configuration | 12 |
Setting this property to null will set it to its default value.
Default value: false
Required
A message that describes the current error.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.| Feature | Version | |
|---|---|---|
| configuration | 11 |
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
The ID of the subscription.Required
A message that describes the current error.Required
A message that describes the current error.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.