Retrieves any queued message representations from the server.
This endpoint is equivalent in functionality to the Event Source with same resource URL, but the response is a JSON payload. The messages should be requested frequently with a short-polling mechanism.
Applications should not utilize this GET method for retrieving messages and the event source in a single session. For more information on handling message retrieval, see Retrieving Messages.
Feature | Version | |
---|---|---|
messaging | 1 |
Required
The ININ session ID 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.Multiple options:
The value can be assigned any of the following options.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.
List item type documentation:
Represents the accessControlGroup configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
The unique identifier used to reference this configuration object.This property can be null.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
Required
The key identifying this pair.Required
The value of this pair.This property can be null.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: false
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can only be set during a POST operation.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
List item type documentation:
Represents the accessControlGroup configuration object.
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 accountCodesConfiguration configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Setting this property to null will set it to its default value.
Default value: false
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.
List item type documentation:
Represents the accountCode configuration object.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This property can be null.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents the accountCode configuration object.
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.
List item type documentation:
Represents the action configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property is required to be present in POST operations.
Property type documentation:
Represents possible values for the actionType property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
A URL action and its corresponding properties.
Required
The URL to open in the browser.Required
The type of popup to use for the URL action.Property type documentation:
Represents possible values for the popupType property.
This property can be null.
List item type documentation:
A parameter to pass with the action.
Required
The name to identify the parameter.Required
The name displayed to the user.Required
Whether to allow or disallow Attendant overrides.Property type documentation:
Represents possible values for the attendantOverrideType property.
This property can be null.
This property can be null.
Property type documentation:
The values to use when the Attendant override type is set to restricted.
Required
Required
List item type documentation:
Represents the action configuration object.
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
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:
A lists of AlertNotifications.
List item type documentation:
Represents the data sent for a given alert. The alert notification contians the data about what alert has changed state, its new state and value.
Required
Gets the ID of the AlertDefinition assoicated with this notifiction.Required
Gets the ID of the AlertRule that the alert was raised on.Required
Gets a value indicating whether this AlertNotification is cleared.Required
Gets the received date and time.Required
Gets the statistic value that triggered this alert notification.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
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 assistance ID for this assistance request.Property type documentation:
Represents a list of message text items for the assistance request.
List item type documentation:
Represents a message text entry for an assistance request.
Required
The message text.Required
The user ID of the participant that added the message text.Required
The date and time the message text was added.Property type documentation:
Represents a list of assistance participants.
List item type documentation:
Describes a participant associated with an assistance item.
Required
The user ID of the participant.Required
The display name of the participant.Required
The action of the participant.Property type documentation:
Represents a list of assistance participants.
List item type documentation:
Describes a participant associated with an assistance item.
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:
Represents a list of assistance requests.
Property type documentation:
Represents a list of assistance requests.
Feature | Version | |
---|---|---|
interactions | 10 |
Feature | Version | |
---|---|---|
interactions | 10 |
Feature | Version | |
---|---|---|
interactions | 10 |
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 subscription's state.Property type documentation:
Provides additional detail for an error.
Required
A message that describes the current error.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
This property can be null.
Property type documentation:
Provides additional detail for an error.
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.
List item type documentation:
Represents the audioSource configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents the audioSource configuration object.
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 ID of the campaign the agent is logged in to.Required
This identifies the rule or supervisor who initiated the agent's campaign login.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 campaign IDs for which a campaign logoff was requested.Required
This identifies the rule or supervisor who initiated the agent's campaign logout request.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 JSON type representing this option.Required
The name of the campaign.Required
The ID of the campaign.Required
The workgroup associated with the campaign.Feature | Version | |
---|---|---|
dialer | 3 |
Feature | Version | |
---|---|---|
dialer | 3 |
Feature | Version | |
---|---|---|
dialer | 3 |
Feature | Version | |
---|---|---|
dialer | 6 |
Required
The JSON type representing this option.Required
The name of the campaign.Required
The ID of the campaign.Required
The ID of the removed campaign.Required
Specifies if the agent has the "Logon Campaign" security right to choose which campaigns to log in to. Agents without this right are automatically logged in to all campaigns they are eligible for. After agents are logged in,ready-for-calls
still needs to be called to have calls routed to them.
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 agent's current break status.Feature | Version | |
---|---|---|
interactions | 8 |
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 ID of the interaction this message corresponds to.Required
The target for this callback.Required
A message that describes the reason for this callback.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
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
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 ID of the interaction this message corresponds to.Required
Required
The chat member responsible for this chat text.Multiple options:
The value can be assigned any of the following options.Required
The type of this chat member.Required
The display name of the chat member.Required
The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.Required
The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.Required
The JSON type representing this option.Required
The type of this chat member.Required
The display name of the chat member.Required
The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.Required
The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.Required
Indicates if this chat member is typing.Required
The chat text.This property can be null.
Required
The timestamp associated with the chat text.Feature | Version | |
---|---|---|
interactions | 10 |
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 ID of the interaction this message corresponds to.Required
Required
The JSON type representing this option.Required
The type of this chat member.Required
The display name of the chat member.Required
The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.Required
The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.Required
Indicates if this chat member is typing.Required
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.
List item type documentation:
Represents the clientButton configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Conditionally Required
This value indicates whether the button will send a custom notification to a handler, launch an application, open an url, or whether no button action was specifed.This property is required to be present in POST operations.
Feature | Version | |
---|---|---|
configuration | 13 |
Feature | Version | |
---|---|---|
configuration | 16 |
Conditionally Required
It indicates whether the button should be available always, only with an active interaction, with any interaction, or whether no availability has been specified.This property is required to be present in POST operations.
Feature | Version | |
---|---|---|
configuration | 13 |
Feature | Version | |
---|---|---|
configuration | 13 |
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 | 13 |
Setting this property to null will set it to its default value.
Default value: false
Feature | Version | |
---|---|---|
configuration | 13 |
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.
Feature | Version | |
---|---|---|
configuration | 13 |
Setting this property to null will set it to its default value.
Default value: false
Feature | Version | |
---|---|---|
configuration | 13 |
Setting this property to null will set it to its default value.
Default value: false
This is a read only property and can not be changed with PUT or POST operations.
Feature | Version | |
---|---|---|
configuration | 13 |
This property can be null.
Feature | Version | |
---|---|---|
configuration | 13 |
This property can be null.
Feature | Version | |
---|---|---|
configuration | 13 |
This property can be null.
Feature | Version | |
---|---|---|
configuration | 13 |
This property can be null.
Feature | Version | |
---|---|---|
configuration | 16 |
This property can be null.
List item type documentation:
Represents the clientButton configuration object.
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.
List item type documentation:
Represents the clientConfigurationTemplate configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
List item type documentation:
Represents the clientConfigurationTemplate configuration object.
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.
List item type documentation:
Represents the clientTemplate configuration object.
This property can be null.
\
', '/
', ':
', '*
', '?
', '"
', '<
', '>
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This property can be null.
This is a read only property and can not be changed with PUT or POST operations.
Setting this property to null will set it to its default value.
Default value: false
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents the clientTemplate configuration object.
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 state of the connection before the change.Required
The state of the connection after the connection change.Required
A description of the condition that caused the change in connection state.newConnectionState
is set to down
, an unspecified value should be
assumed to be false
.
Feature | Version | |
---|---|---|
connection | 3 |
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
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
True if the result count exceeds the maximum number of results specified.This property can be null.
Required
The ID of the recording.Feature | Version | |
---|---|---|
quality-management | 4 |
Required
Interaction ID of the recording.This property can be null.
Required
The recording time in UTC.This property can be null.
Required
The version of the recording.This property can be null.
This property can be null.
Bit Flags
The session user's rights for the recording.Feature | Version | |
---|---|---|
quality-management | 4 |
Property type documentation:
Recording security policy rights bit flags.
This property can be null.
Required
The scorecard result data for this recording.Required
The scorecard ID.Required
The scorecard's questionnaire ID.This property can be null.
This property can be null.
This property can be null.
Required
The UTC time this scorecard was last modified.Required
The scorecard's scoring state.This property can be null.
Required
The scorecard's current score percentage.Required
The state of the scorecard's signature.Required
The state of this scorecard for calibration purposes.This property can be null.
This property can be null.
This property can be null.
Required
The unique ID for the completed survey.Required
The ID of the survey.This property can be null.
This property can be null.
This object is received when Process Automation Server (PAS) is instructing the application to close the work item instance for any reason. The message may be received under a varierty of circumstances ranging from a user pressing a button that caused the work item to end, to Process Automation Server forcing the page to close because the work item is in error, etc..
Note that it is possible for a process to go into error after a work item is picked up but before the first page of the work item is displayed. For example, an error could occur while running an action at the start of a work item, or before showing the first page of the work item. In such cases, the event to close the work item because of a process error will still be received even though an event to show a page was never received.
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
This property indicates the ID of the work item instance from which this message was received.
This property indicates the reason why the work item page is being closed.
This object is returned after Process Automation Server (PAS) has completed the processing of page command. The object is returned regardless of the commandType, regardless of whether there was or was not any data to be saved, and regardless of whether data to be saved was valid or invalid.
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
This property indicates the ID of the work item instance from which this message was received.
Required
This property contains the same token that was included in the response when the page command was queued. It can be used to correlate this event message to the request that caused the caused the event to occur.
Required
This property is null if the queued page command completed successfully, or is an error object if the page command failed. For translating the error codes, 0 equals unknown error, 1 equals invalid data items, and 2 equals an invalid command ID.
This property can be null.
Property type documentation:
Provides additional detail for an error.
This property contains the list of data that was invalid and could not be saved by Process Automation Server (PAS). Data that was valid and successfully saved is not included within this list.
Property type documentation:
This object defines a list of dataReference objects.
This property indicates the fully-scoped ID of the data that is being referenced.
See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.
This object is received when it is time to show a new page for the work item instance. A work item instance will generally receive one of these messages soon after the subscription for the current page is established, and may receive another one of these messages soon after a Save or Cancel command is sent.
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
This property indicates the ID of the work item instance from which this message was received.
Required
This property indicates the current Work Item Dynamic Details of the work item instance for which the page is being displayed.
Required
This property indicates the ID of the specific page instance that is being shown as the current page. Each time a command is sent to PAS for the current page, that command request must also include this ID.
This property contains the data values, if any, used for the indicated page. The string value is to be JSON formatted per the IPA Device Independent Work Item Data Value Format.
Property type documentation:
This class defines the structure that contains the list of runtime data values, item selections, etc.
Required
This property contains meta infomation about the data values.
Required
The JSON type representing this option.Required
This field specifies the type of payload that is described by the object that contains this meta object.
The value of this field will always be "dataValue" for the data values received as part of a show page event message.
Required
This field contains a string value that looks like a typical #.#.#.# version string. The numbers represented in this string may change over time as new features are added to IPA.
The current value for formatVersion
is 3.0.0.0
.
This property contains the list of runtime data values that described the data object instances used on the work item page.
This property can be null.
Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of boolean values to use for this boolean data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a boolean value to use for this data object instance collection item . If this field is not emitted or if its value is null, then an not set should be assumed.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a boolean value to use for this data type object instance . If this field is not emitted or if its value is null, then an not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of complex values to use for this items collection for complex data collection instance. If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a complex object value to use for this data object instance collection item . If this field is not emitted or if it value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a complex object value, includes values for the object's properties and may include a unique ID depending on the context in which this class is used.
This field contains the unique identifier ($ID) for the complex data type instance. If the field is not emitted, then it should be assumed that either the field does not apply in this context, or that no unique ID was defined for the corresponding complex data type definition. But, if the value is null or empty string, then it should be assumed that a unique ID is defined, but the value resolves to null or empty string.
It should be noted that, unlike most of the other fields with a name that ends in "Id" that are GUIDs, this uniqueId field is not a GUID. Rather, the value of this field is a string calculated by Process Automation Server. For example, it could be the concatentation of all of the string representations from all of the fields identified as being part of the unique identifier within the complex data definition. Or, it could be the result of a custom calculation.
The class that contains this value is used in various different contexts, and this uniqueId field does not apply in every context. The unique ID is a runtime concept, so it does not make sense in definitions. Similarly, the value is only calculated by Process Automation Server, so it does not make sense when sending values from a client to the server.
This property can be null.
This field contains the values to use for the various properties of a complex object.
This property can be null.
Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of boolean values to use for this boolean property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a boolean value to use for this complex object property value . If this field is not emitted or if its value is null, then an not set should be assumed.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
Recursive
TODO: Description.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
Recursive
This field contains a complex object value to use for this complex object property value . If this field is not emitted or if it value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a complex object value, includes values for the object's properties and may include a unique ID depending on the context in which this class is used.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of currency values to use for this currency property value collection . If this field is not emitted or if its value is null, then a not set should be assumed.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a currency value to use for this data object instance collection item . If this field is not emitted or if its value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a currency value, which includes both an amount and a currency code.
This field contains a string representation of the amount of the currency, which may be postive or negative.
See String Representation of Currency Values for more information about how a currency value is represented.
This property can be null.
This field specifies the currency code that is associated with the amount field.
See String Representation of Currency Values for more information about how a currency value is represented.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a currency value to use for this complex object property value . If this field is not emitted or if its value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a currency value, which includes both an amount and a currency code.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this date property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the string representation of the value to use for this string representation of value . If this field is not emitted or if its value is null, a value of not set should be assumed.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this date complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this date-time property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this date-time complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this decimal property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this decimal complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this duration property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this duration complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this long property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this long complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of mailbox values to use for this mailbox property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a mailbox value to use for this data object instance collection item . If this field is not emitted or if its value is null, then a not set should be assumed.
This property can be null.
Property type documentation:
This class represents a mailbox value, which includes both a string value and a mailbox type.
Required
This field contains a string representation of the mailbox value.
See String Representation of Mailbox Values for more information about how a mailbox value is represented.
Required
This field contains a string representation of the mailbox type. Possible values are show below.
See String Representation of Mailbox Values for more information about how a mailbox value is represented.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a mailbox value to use for this complex object property value . If this field is not emitted or if its value is null, then a not set should be assumed.
This property can be null.
Property type documentation:
This class represents a mailbox value, which includes both a string value and a mailbox type.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this skill property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
The string representation of a skill value is simply the name of the skill.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this skill complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
The string representation of a skill value is simply the name of the skill.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this string property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
The string representation of a string value is simply the string itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this string complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
The string representation of a string value is simply the string itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this time property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this time complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this uri property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
The string representation of a URI value is simply the URI itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this uri complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
The string representation of a URI value is simply the URI itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of user queue values to use for this user queue property value collection . If this field is not emitted or if its value is null, then a not set should be assumed.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a user queue value to use for this data object instance collection item . If this field is not emitted or if its value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a user queue value, which includes both a value (username) and a display name.
Required
This field holds the username associated with the user queue.
See String Representation of User Queue Values for more information about how a user queue value is represented.
This field specifies the display name is associated with the val field. If the field is not emitted or the value is null or empty string, then it is assumed that there is no display name configured in IA for this user.
See String Representation of User Queue Values for more information about how a user queue value is represented.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a user queue value to use for this complex object property value . If this field is not emitted or if its value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a user queue value, which includes both a value (username) and a display name.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this workgroup queue property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this user queue complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a complex object value to use for this data type object instance . If this field is not emitted or if it value is null, then not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a complex object value, includes values for the object's properties and may include a unique ID depending on the context in which this class is used.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of currency values to use for this currency data object instance collection . If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a currency value to use for this data type object instance . If this field is not emitted or if its value is null, then not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a currency value, which includes both an amount and a currency code.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this date data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this date data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this date-time data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this date-time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this decimal data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this decimal data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this duration data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this duration data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this long data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this long data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of mailbox values to use for this mailbox data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a mailbox value to use for this data type object instance . If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a mailbox value, which includes both a string value and a mailbox type.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this skill data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a skill value is simply the name of the skill.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this skill data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a skill value is simply the name of the skill.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this string data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a string value is simply the string itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this string data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a string value is simply the string itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this time data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this uri data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a URI value is simply the URI itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this uri data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a URI value is simply the URI itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of user queue values to use for this user queue data object instance collection . If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a user queue value to use for this data type object instance . If this field is not emitted or if its value is null, then not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a user queue value, which includes both a value (username) and a display name.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this workgroup queue object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this workgroup queue data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
This property contains the lists of selected items for the various controls in the work item page definition, such as a grid, that may be used as single-select or multi-select controls. If this property is not emitted or is null or empty, then the work item page definition must not contain any grids configured for use as selection controls.
It should be noted that the drop list control does not use this same selections property. This is because the drop list is always single select to a collection of basic or simple types (no complex types), and always selects by value and not by object instance ID or unique ID of a complex object.
Also, note that this selections field only applies in the context of a specific page, and does not apply in the context of multiple pages, an entire work item or entire process. Therefore, it can optionally be used in the show page event or when sending a page command, but is not used and will be ignored when launching a process.
This property can be null.
Required
This field indicates the fully scoped GUID that is the ID or the collection that contains the list if items (singleton or complex) from which a selection may be made.
For example, this could be the ID for a collection of basic or simple types displayed in a single-column grid. Or, it could be the ID of a collection that contains a complex object for each row that is to be displayed in a multi-column grid. Either way, this is the ID of a collection of all of the items, not just the selected items.
See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.
Required
This field indicates the fully scoped GUID that is the ID of the variable that holds the selected item (single select mode), or the ID of the collection that holds the list of selected items (multi-select mode).
When configured to select "by unique identifier", the variable indicated by this ID will be a string singleton (single-select mode) or string collection (multi-select mode), and only a string representation of the uniqueId(s) of the selected item(s) will be in that variable.
When configured to select "by data type", the variable indicated by this ID will be a singleton (single-select mode) or collection (multi-select mode) of the same type indicated by the sourceId field, which could be a basic, simple or complex type. And, in this case, a complete copy of each select item is stored in the variable indicated by this destination field; not just the uniqueId(s).
See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.
This field holds the list of simple GUIDs that are the IDs of the selected items, regardless of whether configured to select "by data type" or "by unique identifier".
This field is always a collection regardless of whether single-select mode or mult-select mode is being used. But, at most one item can exist in this list for single-select mode, whereas multiple items can exist in this list for mult-select mode.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This property can be null.
Required
This property contains the URL where the page definition and data definitions can be found for the current page of this work item instance. The page and data definitions for the specific revision of the specific page definition of the specific process definition are wrapped into a JSON file at this location.
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
DataPop information for a call. The specific attributes vary for preview and non-preview calls.Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.Required
The interaction ID for the call being popped.Required
ID of the campaign associated with the call.Required
Contact data for the call.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Required
Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.Required
Specifies if this call can be dispositioned as rescheduled for a specific agent.Required
The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.Required
Name of a disposition choice the agent can select from at the end of a call.Required
The wrap-up category assigned to the call.Required
The wrap-up code assigned to the call.Required
Specifies if a call is marked as abandoned.Required
Dialing mode for the call.Property type documentation:
Specifies constants that indicate the dialing mode for a Dialer call.
Required
The JSON type representing this option.Required
The interaction ID for the call being popped.Required
ID of the campaign associated with the call.Required
Contact data for the call.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Required
Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.Required
Specifies if this call can be dispositioned as rescheduled for a specific agent.Required
The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.Required
Dialing mode for the call.Property type documentation:
Specifies constants that indicate the preview dialing mode for a Dialer call.
Required
Indicates whether Dialer has been requested to place the preview call. If true, attempts to call theplace-preview-call
method fail.
previewTimeout
is the IC server time when the preview countdown expires. Compare this time to the server clock time via GET /icws/connection/server-time to account for client/server time drift. The server does not support initiating a preview call after the countdown is reached. If that functionality is required, it must be included in the client application.
Required
Indicates whether the agent is allowed to skip this preview call. To skip a preview call, call thedisposition
method with a wrapup label of "Skipped - Agent Skip".
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.
Feature | Version | |
---|---|---|
wfm | 4 |
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 defaultUser configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form accessRights.memberName. For example, accessRights.viewUserQueue will return the objects's view user queue access rights. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
Property type documentation:
Represents a collection of groupedConfigurationId's.
List item type documentation:
Represents a dynamic group of Configuration Objects. Example: All Users in the Marketing Workgroup.
This property can be null.
This property can be null.
This property can be null.
Required
The object type that this configuration ID represents.Property type documentation:
Represents the possible object types that can be specified in a groupedConfigurationId.
Required
The grouping for this configuration ID.Property type documentation:
Represents the possible groupings that can be specified in a groupedConfigurationId.
This property can be null.
Property type documentation:
Represents a collection of groupedConfigurationId's.
List item type documentation:
Represents a dynamic group of Configuration Objects. Example: All Users in the Marketing Workgroup.
This property can be null.
Property type documentation:
Represents a collection of groupedConfigurationId's.
List item type documentation:
Represents a dynamic group of Configuration Objects. Example: All Users in the Marketing Workgroup.
This property can be null.
Property type documentation:
Represents a collection of inheritedGroupedConfigurationIds.
List item type documentation:
Represents an inherited groupedConfigurationIdCollection. This type contains properties that indicate where the value was inherited from.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Property type documentation:
Represents the possible object types that can be specified in an inherited from property.
Required
Property type documentation:
Represents a collection of groupedConfigurationId's.
List item type documentation:
Represents a dynamic group of Configuration Objects. Example: All Users in the Marketing Workgroup.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a collection of inheritedBooleanValue.
List item type documentation:
Represents an inherited boolean value. This type contains properties that indicate where the value was inherited from.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Property type documentation:
Represents the possible object types that can be specified in an inherited from property.
Required
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
Feature | Version | |
---|---|---|
configuration | 11 |
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
Feature | Version | |
---|---|---|
configuration | 11 |
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
Feature | Version | |
---|---|---|
configuration | 11 |
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
Feature | Version | |
---|---|---|
configuration | 11 |
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
Feature | Version | |
---|---|---|
configuration | 14 |
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form administrativeRights.memberName. For example, administrativeRights.masterAdministrator will return the objects's master administrator right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
Feature | Version | |
---|---|---|
configuration | 14 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
Feature | Version | |
---|---|---|
configuration | 18 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a collection of inherited strings.
List item type documentation:
Represents an inherited string. This type contains properties that indicate where the value was inherited from.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Property type documentation:
Represents the possible object types that can be specified in an inherited from property.
Required
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a collection of inherited durations.
List item type documentation:
Represents an inherited duration. This type contains properties that indicate where the value was inherited from.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Property type documentation:
Represents the possible object types that can be specified in an inherited from property.
Required
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form securityRights.memberName. For example, securityRights.mobileOfficeUser will return the objects's mobile office security right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 18 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 5 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 11 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 15 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 5 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 11 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Setting this property to null will set it to its default value.
Default value: 0
Setting this property to null will set it to its default value.
Default value: -25
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.
List item type documentation:
Represents the dialPlanClassification configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents the dialPlanClassification configuration object.
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.
The directory's access rights. This property will be omitted if there are no access rights to this directory.
Prior to version 8 the server was sending only admin property if the loggedin user is having the Directory Administrator ACL, which is insufficient to decide if the directory is read only.
Feature | Version | |
---|---|---|
directories | 8 |
Required
The directory's ID.Required
The directory's display name.Required
The directory's schema ID.Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
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 JSON type representing this option.Feature | Version | |
---|---|---|
directories | 7 |
Feature | Version | |
---|---|---|
directories | 7 |
Property type documentation:
Represents a phone number.
Required
The standardized phone number.Required
The phone number's display string.Feature | Version | |
---|---|---|
directories | 8 |
The string to use when editing the phone number. This property contains the phone number and/or an extension. They are delimited by /^ when the extension is autodialed, and just ^ when it isn't. Extensions without a number will always be returned as autodialed.
editNumber has been marked obsolete. displayString can be used in its place, as it provides identical information. Alternatively numberInfo can be used for to retrieve similar information as it contains the parsed information found in displayString.
Feature | Version | Obsolete Version |
---|---|---|
directories | 6 | 8 |
Property type documentation:
Represents a phone number.
Property type documentation:
Represents a phone number.
Required
A unique identifier for the contact.Property type documentation:
Represents a phone number.
Property type documentation:
Represents a phone number.
Property type documentation:
Represents a phone number.
Required
The zero-based index of this contact within the directory subscription's current page.Property type documentation:
Represents a phone number.
Property type documentation:
Represents a phone number.
Feature | Version | |
---|---|---|
directories | 5 |
The ID of the status message that the specified contact is currently set to.
The value represented by this property should be treated as case-insensitive.
This property can be null.
The directory contact's status notes. This property will only be provided if the logged-in user has View access for the "Status Summary" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "Status Summary" | Directory Status Columns - Status Summary - View |
This property can be null.
Required
The ID of the status message that the specified contact is currently set to.
The value represented by this property should be treated as case-insensitive.
Required
Whether the contact is logged in.Required
Whether the contact is on the phone.The directory contact's status notes. This property will only be provided if the logged-in user has View access for the "Notes" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "Status Notes" | Directory Status Columns - Notes - View |
This property can be null.
The directory contact's forward number. This property will only be provided if the logged-in user has View access for the "Forward Number" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "Forward Number" | Directory Status Columns - Forward Number - View |
This property can be null.
Property type documentation:
Represents a phone number.
The contact's status until time. This property will only be provided if the logged-in user has View access for the "Until" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "Until" | Directory Status Columns - Until - View |
This property can be null.
Property type documentation:
Clients must supply a complete UTC dateTime, regardless of the user specifying only date or only time. The hasDate and hasTime members have to do with UI, not the completeness of untilDateTime. If a user specifies only a date, clients must use the UTC dateTime converted from midnight local time for that date. If a user specifies only a time, clients must use the UTC dateTime converted from today's date at that local time.
Required
The status until date and time.This property will only be applied if CanHaveDate and CanHaveTime are true.
Required
This has to do with UI, not the untilDateTime.Required
This has to do with UI, not the untilDateTime.The contact's onPhone status. This property will only be provided if the logged-in user has View access for the "On Phone" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "On Phone" | Directory Status Columns - On Phone - View |
This property can be null.
The directory contact's status onPhoneChanged. This property will only be provided if the logged-in user has View access for the "On Phone" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "On Phone" | Directory Status Columns - On Phone - View |
This property can be null.
The directory contact's statusChanged. This property will only be provided if the logged-in user has View access for the "Time In Status" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "Time In Status" | Directory Status Columns - Time In Status - View |
This property can be null.
The directory contact's status loggedIn. This property will only be provided if the logged-in user has View access for the "Logged In" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "Logged In" | Directory Status Columns - Logged In - View |
This property can be null.
The directory contact's status stations. This property will only be provided if the logged-in user has View access for the "Logged In" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "Logged In" | Directory Status Columns - Logged In - View |
This property can be null.
The directory contact's status icServers. This property will only be provided if the logged-in user has View access for the "Logged In" ACL in the "Directory Status Columns" group.
Type | API Name | UI Name |
---|---|---|
Access Right | viewStatusColumns "Logged In" | Directory Status Columns - Logged In - View |
This property can be null.
Required
The subscription's ID.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
New effective station information.This property can be null.
Required
The ID of the station for the session.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
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 ID of the interaction this message corresponds to.Required
Indicates whether or not the email can be edited by the current user.Required
Required
The JSON type representing this option.Required
The sender's email address.Required
The display name for the email address.Required
The email bodies.Required
An email body.Required
The type of the email body.Required
The timestamp of when the email was received.Feature | Version | |
---|---|---|
interactions | 9 |
Required Bit Flags
The status of the signature.Property type documentation:
The email signature validation status provided by Interaction Center.
Required
The certificate used for the signature.Required
The version of the certificate.Required
The serial number of the certificate.Required
The algorithm used for the signature of the certificate.Required
The issuer of the certificate.Required
The start of the period for which the certificate is valid.Required
The end of the period for which the certificate is valid.Required
The subject of the certificate.Required
The JSON type representing this option.Required
The name of the file.Required
The Content-ID of the file, which conforms to RFC 2111.Required
The location where the file can be downloaded.By default, when GETing the file, ICWS
will respond with the 'Content-Type' header set to the proper content type of the file.
When making a request from a web browser, it may be desirable to force the file to be downloaded. In this case the query string '?action=download' should be added to the end of a file's downloadUri. This will force the response header 'Content-Type' to be set to 'application/octet-stream' and will add the header 'Content-Disposition' set to 'attachment'.
Required
The JSON type representing this option.Required
The subject of the attached message.Required
The identifier used to retrieve the attached message.Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 12 |
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
The ID of the interaction this message corresponds to.Required
The content of the email.Required
The JSON type representing this option.Required
The subject of the email.Required
The sender's email address.Required
The email bodies.Required
The timestamp of when the email was received.Feature | Version | |
---|---|---|
interactions | 9 |
Recursive
The email's message attachments. Note: These will be the actual attached messages instead of just the subject and associated retrieval messageId as they are with an emailContentsResponse.Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
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 subscription's state.Property type documentation:
Provides additional detail for an error.
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
The ID of the interaction this message corresponds to.Required
The name of the file being uploaded.Required
Indicates file upload success.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 subscription's state.Property type documentation:
Provides additional detail for an error.
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.
List item type documentation:
A unified-message of type fax.
Required
The JSON type representing this option.Required
The unique identifier for the message.Required
The current state of the message.Required
The date/time stamp the message was received.Required
The party that sent the message.Required
The subject of the message.Required
A list of file attachment objects associated with the message.Required
The URI to access the message file.Required
The message file name.List item type documentation:
An update for a unified-message of type fax.
Required
The JSON type representing this option.Required
The unique identifier for the message.Required
The current state of the message.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 identifier of the object for the notification.
The value represented by this property should be treated as case-insensitive.
Required
The identifier of the event for the notification.
The value represented by this property should be treated as case-insensitive.
Required
A list of strings that were provided by the handler which sent the notification.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.
List item type documentation:
Contains history information for an interaction.
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.
List item type documentation:
Represents the imageResource configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
This property can be null.
This property can be null.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
List item type documentation:
Represents the imageResource configuration object.
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:
A collection of Interaction Alerting event details.
Required
The unique identifier of the Interaction that is alerting.Required
The type of Interaction that is alerting. This will be valued with the 'objectType' Interaction attribute value.Required
The name associated to the party that initiated the Interaction.Required
The telephone number, telephone extension, email address, or other such origin of the Interaction.Required
Indicates the type of Interaction Alerting event that is being raised.Required
Specifies whether the Alerting event is instructing the consumer to begin, or to end, alerting the end user.Required
Indicates whether the alerting Interaction should be picked up automatically.Property type documentation:
A queueId containing the queue type and its name.
Required
The type of queue being identified.Required
The name of the queue being identified.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.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 interaction's ID.Required
A dictionary of attributes subscribed to, and their corresponding values.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.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 interaction's ID.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 interaction's ID.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 interaction's ID.Required
The new interaction ID after the morph.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 interactionRecorderConfiguration configuration object.
Feature | Version | |
---|---|---|
configuration | 11 |
This property can be null.
This property can be null.
Feature | Version | |
---|---|---|
interactions | 13 |
Feature | Version | |
---|---|---|
interactions | 13 |
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 interaction's ID.Required
The new snippetRecording Id.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
The name of the job.
Required
The user ID that was used to submit the job.
Required
The unique ID associated with the job. This value is set by the server at the time the job is created.
Required
The site ID associated with the user who submitted the job.
The datetime the job was submitted.
The datetime the job was queued.
The datetime the job was canceled.
The datetime the job finished.
The datetime the job started.
The datetime the job failed.
The datetime the job last changed state.
The user ID that cancelled the job.
The output path where the extracted files were saved to.
Additional error information.
When the job has been submitted.
When the job has been queued.
When the job has been started.
If the job failed.
If the job was canceled.
When the job has finished.
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.
List item type documentation:
Represents the keywordSet configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
This property can be null.
Property type documentation:
Represents a list of keyword configuration objects.
List item type documentation:
Represents the keyword configuration object.
Setting this property to null will set it to its default value.
Default value: 0
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: 0
This property can be null.
Setting this property to null will set it to its default value.
Default value: 0.5
This property can be null.
Property type documentation:
Represents a collection of strings.
This property can be null.
Property type documentation:
Represents a collection of strings.
This property can be null.
Property type documentation:
Represents a collection of strings.
This property can be null.
Property type documentation:
Represents a collection of strings.
List item type documentation:
Represents the keywordSet configuration object.
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.
This property contains the list of processes definitions that have just become launchable by the current user. The process may have just been published or activated, the user may have just been granted the appropriate ACLs, etc.
Property type documentation:
This object defines a list of processDefinitionDescription objects.
List item type documentation:
This object contains information that identifies and describes a specific revision of a process definition.
Required
This is the ID associated with the process definition. This ID does not change as new revisions of the process are created, modified or published.
Required
This is the revision of the process indicated by the processDefinitionId. Each different published version of the same process will have the same processDefinitionId, but will have a different revision.
Required
This is the current name of the process definition indicated by the processDefinitionId. All revisions of the process definition with the same processDefinitionId share the same current name.
Required
This is the current description the process definition indicated by the processDefinitionId. All revisions of the process definition with the same processDefinitionId share the same current description.
This property contains the list of processes definitions that are already launchable by the current user, but just had a revision, name or description change.
Property type documentation:
This object defines a list of processDefinitionDescription objects.
List item type documentation:
This object contains information that identifies and describes a specific revision of a process definition.
This property contains the list of IDs for the process definitions that were previously launchable by the current user, but are no longer launchable by that user. The process may have been deactivated or deleted, the user may no longer have the appropriate ACLs, etc.
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.
List item type documentation:
Represents the layout configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: 10
Setting this property to null will set it to its default value.
Default value: 10
List item type documentation:
Represents the layout configuration object.
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
Indicates whether or not the license is assigned to the user. An assigned license has not necessarily been acquired.
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.
Feature | Version | |
---|---|---|
configuration | 12 |
Setting this property to null will set it to its default value.
Default value: false
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
The ID of the campaign.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
Id of the campaign for which manual outbound call was initiated.Required
Id of the agent that initiated the manual outbound call.Required
Dialer Identity of the manual outbound call.Required
Manual outbound call status.Required
Contact record was excluded by the campaign filter.Required
Contact was zone blocked.Required
Agent initiating the call does not have the skills necessary.Required
The number of calls for the contact reached the daily limit.Required
Minimum spacing between calls is not satisfied.Required
Contact does not belong to the campaign initiating the call.Required
Contact is blocked by Do-Not-Call policy.Required
Contact record was excluded by the campaign query time filter.Required
A flag indicating the phone number associated with the call has been previously dialed.Required
The status of the record when uncallable.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 identifier for a memo.Required
A memo.The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}
.
Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.
Requests for PNG memo icons support an optional iconSize
parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16
. The default iconSize is 32 without this parameter.
Required
The identifier for a memo.Required
A memo.The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}
.
Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.
Requests for PNG memo icons support an optional iconSize
parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16
. The default iconSize is 32 without this parameter.
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
A count of waiting (unread) messages. When this field is zero there are no waiting messages.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 subscription's state.Property type documentation:
Provides additional detail for an error.
Feature | Version | |
---|---|---|
dialer | 3 |
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 state of the connection before change.Required
The state of the connection after the connection change.Required
A description of the condition that caused the change in connection state.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.
This property indicates the current run state of Process Automation Server (PAS).
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.
List item type documentation:
Represents the passwordPolicy configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: 30
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: false
Feature | Version | |
---|---|---|
configuration | 2 |
This property can be null.
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: 30
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: 5
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: 180
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: 14
Feature | Version | |
---|---|---|
configuration | 10 |
Setting this property to null will set it to its default value.
Default value: 0
Feature | Version | |
---|---|---|
configuration | 10 |
Setting this property to null will set it to its default value.
Default value: 0
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: 2
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: 24
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: 8
Feature | Version | |
---|---|---|
configuration | 10 |
Setting this property to null will set it to its default value.
Default value: 0
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: 4
Feature | Version | |
---|---|---|
configuration | 10 |
Setting this property to null will set it to its default value.
Default value: 0
Feature | Version | |
---|---|---|
configuration | 2 |
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Feature | Version | |
---|---|---|
configuration | 10 |
This property can be null.
Feature | Version | |
---|---|---|
configuration | 2 |
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Feature | Version | |
---|---|---|
configuration | 2 |
Setting this property to null will set it to its default value.
Default value: false
List item type documentation:
Represents the passwordPolicy configuration object.
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
A list of recording IDs.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.
List item type documentation:
Represents the position configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Setting this property to null will set it to its default value.
Default value: 0
This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: 0
Setting this property to null will set it to its default value.
Default value: 0
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: 0
List item type documentation:
Represents the position configuration object.
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 problemReporter configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a collection of strings.
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.
List item type documentation:
Represents the queueColumn configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property is required to be present in POST operations.
This property can be null.
This property is required to be present in POST operations.
This property can be null.
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.
This is a read only property and can not be changed with PUT or POST operations.
Setting this property to null will set it to its default value.
Default value: false
List item type documentation:
Represents the queueColumn configuration object.
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 subscription ID that this message correlates to.List item type documentation:
An interaction containing the interaction ID and its interaction attribute values. In addition it contains a possible conference parent interaction ID.
Required
The interaction ID of the interaction.Required
A dictionary of attributes subscribed to, and their corresponding values.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.List item type documentation:
An interaction containing the interaction ID and its interaction attribute values.
Required
The interaction ID of the interaction.Required
A dictionary of attributes subscribed to, and their corresponding values.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Feature | Version | |
---|---|---|
queues | 2 |
Feature | Version | |
---|---|---|
queues | 2 |
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 subscription's state.Property type documentation:
Provides additional detail for an error.
Required
The subscription ID that this message correlates to.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.
List item type documentation:
Represents the recordingBeepTone configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property is required to be present in POST operations.
This property is required to be present in POST operations.
This property is required to be present in POST operations.
This property is required to be present in POST operations.
This property is required to be present in POST operations.
This property is required to be present in POST operations.
List item type documentation:
Represents the recordingBeepTone configuration object.
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 Subscription's Id.Required
This is same as what is provided in subscription parameters. eg. indivId, orgId, locId.Required
The Interaction's Id.Required
The JSON type representing this option.Required
Participant's indivID.Required
Participant's display name.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.
List item type documentation:
Represents the responseManagementDocument configuration object.
\
', '/
', ':
', '*
', '?
', '"
', '<
', '>
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This property can be null.
This property can be null.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents the responseManagementDocument configuration object.
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 identifier for the library.Required
The name for the library.Required
The URL to download the library.Required
A value that represents the current version of a library. It is used by the client to avoid requesting a version of the library that the client already has.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
This property can be null.
Property type documentation:
Provides additional detail for an error.
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.
List item type documentation:
Represents the role configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form accessRights.memberName. For example, accessRights.viewUserQueue will return the objects's view user queue access rights. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form administrativeRights.memberName. For example, administrativeRights.masterAdministrator will return the objects's master administrator right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form securityRights.memberName. For example, securityRights.mobileOfficeUser will return the objects's mobile office security right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
List item type documentation:
Represents the role configuration object.
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.
List item type documentation:
Represents the salesforceCTIConfiguration configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
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
This property can be null.
Property type documentation:
Represents a list of salesforceCtiAttributeMap configuration objects.
List item type documentation:
Represents the salesforceCtiAttributeMap configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Setting this property to null will set it to its default value.
Default value: false
This property can be null.
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
This property can be null.
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
This property can be null.
This property can be null.
Setting this property to null will set it to its default value.
Default value: false
List item type documentation:
Represents the salesforceCTIConfiguration configuration object.
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.
List item type documentation:
Represents the schedule configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Setting this property to null will set it to its default value.
Default value: true
,
'.This property can be null.
Property type documentation:
Represents a collection of strings.
This property can be null.
Property type documentation:
Represents a list of scheduleRecurrence configuration objects.
List item type documentation:
Represents the scheduleRecurrence configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Feature | Version | |
---|---|---|
configuration | 7 |
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of integers.
This property can be null.
Property type documentation:
Represents a collection of integers.
This property is required to be present in POST operations.
This property is required to be present in POST operations.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Weekly Day List
:isDaySpan
days
Weekly Day Span
:isDaySpan
days
weeklyStartTime
weeklyEndTime
Monthly Day List
:isRelative
dates
Monthly Relative
:isRelative
relativeDay
relativeMonthlyInstance
Yearly Day List
:isRelative
dates
month
Yearly Relative
:isRelative
relativeDay
relativeMonthlyInstance
month
This property is required to be present in POST operations.
This property can be null.
This property can be null.
This property is required to be present in POST operations.
This property is required to be present in POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents the schedule configuration object.
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.
List item type documentation:
Represents the secureInputForm configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a list of secureInputFormCustomParameter settings.
List item type documentation:
Represents a secure input form custom parameter.
Required
Required
This property can be null.
This property can be null.
Property type documentation:
Represents a list of secureInputFormFieldDefinition settings.
List item type documentation:
Represents a secure input form field definition.
Required
Required
This property can be null.
This property can be null.
This property can be null.
List item type documentation:
Represents the secureInputForm configuration object.
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.
List item type documentation:
Represents the serverParameter configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
List item type documentation:
Represents the serverParameter configuration object.
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 name of the application or program used to create the session. E.g., "Interaction Client .NET Edition".Required
The name of the machine or computer where the session was created, if captured at login. This field will be an empty string if there is no machine information.Required
The ID of the station for the session. This field will be an empty configuration ID for a stationless session.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
The ID of the user who created the session.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
The event that resulted in the session being added or removed.
connectionChange
represents an explicit login or logout.configurationChange
indicates that the session has been added to or removed from the client's view because of a configuration change.
For example, if station 123 has a session and is added to (or removed from) layout ABC, a client with a subscription to layout sessions would receive a message with a configurationChange
reason.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
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
Campaign ID for Base Script definition.Required
Base Script form definition.Required
Collection of pages used within a Base Script.Required
Name of the Base Script page.Required
Form controls for a Base Script page.Required
Database column linked to control.Required
Label of the Base Script page.Required
Specifies whether control has read-only property set.Required
Specifies type of control to display.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Required
The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.Required
Name of a disposition choice the agent can select from at the end of a call.Required
The wrap-up category assigned to the call.Required
The wrap-up code assigned to the call.Required
Specifies if a call is marked as abandoned.Required
Record status assigned for this disposition.Required
Specifies if this disposition is considered a contact.Required
Static text of the Base Script page.Required
Foreground color of the Base Script page.Required
Background color of the Base Script page.Required
Miscellaneous options configured for a Base Script.Required
Specifies whether this base script allows agents to request break.Required
Specifies whether this base script allows agents to skip calls.Required
Specifies whether this base script allows agent-owned callbacks.Required
Specifies whether this base script should use 24-time format.Required
Specifies whether this base script should automatically pick-up alerting calls.Required
Specifies whether this base script allows scheduling.Required
Specifies whether this base script allows auto disconnect on disposition.Required
Specifies whether this base script allows editing of Number to Dial.Required
Specifies whether this base script allows agents to place Additional Followup calls.Required
Specifies whether this base script allows editing Additional Call Numbers.Required
Specifies whether this base script allows overriding DNC block for manual calls.Required
Specifies whether this base script allows overriding zone block for manual calls.Required
Specifies whether this base script allows overriding skills block for manual calls.Required
Specifies whether this base script allows overriding daily limit block for manual calls.Required
Contains list of allowable extensions to dial.Required
Object display name.Required
Extension number.Required
Type of the object [Station, User, Workgroup, StationGroup or Attendant].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.
List item type documentation:
Represents the skillCategory configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
List item type documentation:
Represents the skillCategory configuration object.
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.
List item type documentation:
Represents the skill configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a set of skill settings.
List item type documentation:
Represents a skill setting.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Required
This property can be null.
Property type documentation:
Represents a set of skill settings.
List item type documentation:
Represents a skill setting.
List item type documentation:
Represents the skill configuration object.
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
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
Indicates the station extension.Required
Indicates the station ID.Required
This represents Managed IP Phone.Feature | Version | |
---|---|---|
connection | 15 |
Required
This represents emergency responder location ID for the emergency address stored in station object.Feature | Version | |
---|---|---|
connection | 15 |
Required
The station setting used to create the station connection representation.Feature | Version | |
---|---|---|
connection | 13 |
Feature | Version | |
---|---|---|
connection | 13 |
Feature | Version | |
---|---|---|
connection | 13 |
Required
The station connection information after the change.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
A list of statistic categories that make up the statistic catalog.Required
The ID of the statistic category.Required
A user friendly string for display purposes.Required
A description of the statistic category.Required
A list of statistic definitions that make up this statistic category.Required
The ID of the statistic definition.Required
A user friendly string for display purposes.Required
A description of the statistic definition.Required
The display string to define the measurement of units.Required
A list of required parameter definitions.Required
The types of parameters required in a specific order.Required
Gets a value indicating whether this should be suppressed from direct presentation to the user.Required
Additional data that is associated with this statistic definition.Required
The precision of the data.Required
The measurement of units for this statistic definition.Feature | Version | |
---|---|---|
statistics | 4 |
Required
Additional flags that may be set to modify a statistic definition.Required
Required
The ID of the drill down.Required
The hint as to what the format is of the drill down data.Required
The string that gives a hint as to what this drill down data refers to.Required
A list of access rights that the user should have in order to see this catalog.Required
A list of the licenses that the user should have in order to see this catalog.Required
A list of parameter type definitions that represent additional details for a parameter type object.Required
The ID of the parameter type.Required
A user friendly string for display purposes.Required
The description of the associated parameter type.Required
Each of the access control lists returned by this property could be used to fetch parameter values that the Session user is allowed to use. When retrieving available parameter values associated with this ParameterTypeDefinition, the values will be filtered to only include items allowed by these access control lists.Required
True if the display order should be preserved; otherwise false.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.
List item type documentation:
Represents the statisticParameterGroup configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
List item type documentation:
Represents the statisticParameterGroup configuration object.
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
The value type of the statistic.This property can be null.
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 ID of the status message. Used to refer to or set the status message.
The value represented by this property should be treated as case-insensitive.
Required
Localized message text when displaying this status. Appears in list of selectable statuses.Required
The icon associated with this status message.Required
The group this status belongs to for reporting. A Status Group is a name that loosely categorizes a status message for reporting purposes. When a new status is defined in Interaction Administrator using the System Configuration < Status Messages container, it is mapped to a Status Group for reporting purposes.Required
Indicates whether this status can have an ending date.Required
Indicates whether this status can have an ending time.Required
Indicates whether this status is a do not disturb status.Required
Indicates whether this status is selectable by an agent.Required
Indicates whether this status can persist when the agent logs out of IC.Required
Indicates whether this status is a forwarding status.Required
Indicates whether this status requires after call work (ACW). Indicates that an agent is in "Follow Up" mode (IsAllowFollowUpStatus) after an ACD call.Required
Indicates whether an agent is available to receive ACD calls.Required
Indicates that an agent's status can change to "Follow Up" after an ACD call terminates.Required
An unique numeric identifier for this status message.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
List of changes to a user's status regarding the rights granted to the user.Required
The unique identifier for this user status entry. This is the IC User name.A list of added status message IDs that the user has rights to.
The values represented in this property should be treated as case-insensitive.
A list of status message IDs the user no longer has rights to.
The values represented in this property should be treated as case-insensitive.
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.
List item type documentation:
Represents the structuredParameter configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Required
Required
Required
This property can be null.
Property type documentation:
Represents a collection of strings.
List item type documentation:
Represents the structuredParameter configuration object.
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 system configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
The unique identifier used to reference this object.This property can be null.
This is a read only property and can not be changed with PUT or POST operations.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents a collection of idDisplayNames's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of idDisplayNames's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
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.
List item type documentation:
Represents the systemParameter configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Feature | Version | |
---|---|---|
configuration | 8 |
This property can be null.
List item type documentation:
Represents the systemParameter configuration object.
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 ID of the watched subscription.Required
The ID of the user of this activation record.Required
Workgroups for which the user's activation changed, and the new activation state.Property type documentation:
Represents a collection of key/value pairs where each key is a string and each value is a boolean.
Required
The key identifying this pair.Required
The value of this pair.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
List item type documentation:
A single user status.
User statuses only contain the statusId
property and additional members specific to a user.
Clients need to retrieve
status messages
in order to map to a status message (for messageText etc.) using the statusId
property.
Required
The unique identifier for this user status to update. This is the IC User name.
Required
The ID of the status message that the specified user is currently set to.
The value represented by this property should be treated as case-insensitive.
The status message notes set by user.
The forward number set by user.
The user status until time.
This property can be null.
Property type documentation:
Clients must supply a complete UTC dateTime, regardless of the user specifying only date or only time. The hasDate and hasTime members have to do with UI, not the completeness of untilDateTime. If a user specifies only a date, clients must use the UTC dateTime converted from midnight local time for that date. If a user specifies only a time, clients must use the UTC dateTime converted from today's date at that local time.
This property indicates whether the user is on phone.
This property is updated when status on onPhone changes.
This property is update when user status changes.
The stations on which the user is logged in.
The name of the icServers to which the user is connected to.
The name of the server that is providing status for this user.
Indicates whether or not the user is logged into a station.
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
List of previous users' information.Required
Previous status message identifier defined from StatusMessageList.
The value represented by this property should be treated as case-insensitive.
Required
Previous status notes.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.
List item type documentation:
Represents the user configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form accessRights.memberName. For example, accessRights.viewUserQueue will return the objects's view user queue access rights. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
Setting this property to null will set it to its default value.
Default value: false
This property can be null.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form administrativeRights.memberName. For example, administrativeRights.masterAdministrator will return the objects's master administrator right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
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
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
This property can be null.
Property type documentation:
Represents an inherited ConfigurationId property.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of inheritedConfigurationId.
List item type documentation:
Represents an inherited configuration ID. This type contains properties that indicate where the value was inherited from.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Property type documentation:
Represents the possible object types that can be specified in an inherited from property.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
Property type documentation:
Represents client template assignments.
List item type documentation:
Represents client template assignment.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Required
Setting this property to null will set it to its default value.
Default value: 0
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
Feature | Version | |
---|---|---|
configuration | 16 |
This property can be null.
Setting this property to null will set it to its default value.
Default value: false
This property can be null.
Setting this property to null will set it to its default value.
Default value: true
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
This is not a user property. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form licenseProperties.memberName. For example, licenseProperties.additionalLicenses will return the user's additional license assignments. Alternatively, one can use the '*' wildcard to select all properties of the user including these.
Feature | Version | |
---|---|---|
configuration | 14 |
This property can be null.
Feature | Version | |
---|---|---|
configuration | 14 |
This property can be null.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: 0
Property type documentation:
Represents the possible media types that can be used for license assignments.
Setting this property to null will set it to its default value.
Default value: false
none
- this user is not a user of Interaction Process Automation.directRoutedWorkItems
- this user can start any process to which it has rights. Additionally, the user can receive Work Items that are directly routed to it.groupRoutedWorkItems
- this user can receive Work Items that are routed to it directly or from a workgroup it is assigned to.processMonitor
- this user can view process status and details in the Interaction Process Automation Monitor or use Interaction Process Automation Reporting in Interaction Center Business Manager Applications.processDesigner
- this user can the Interaction Process Automation Designer to create and modify Interaction Process Automation processes.Setting this property to null will set it to its default value.
Default value: 0
Property type documentation:
Represents the possible media types that can be used for license assignments.
Setting this property to null will set it to its default value.
Default value: false
media1
- can handle 1 interaction type at a time.media2
- can handle 2 interaction type at a time.media3
- can handle an unlimited number of interaction types at a time.media1
and media2
requires one and two values respectively for the mediaTypes
property to be set. The supported
media types for this are call
, chat
, email
, and generic
. The other interaction types,
callback
, and workItem
, are not supported for ACD interactions.
Setting this property to null will set it to its default value.
Default value: 0
Property type documentation:
Represents the possible media types that can be used for license assignments.
mediaLevel
is populated.mediaLevel
property for more details.
This property can be null.
Property type documentation:
Represents a list of media types.
Feature | Version | |
---|---|---|
configuration | 14 |
Feature | Version | |
---|---|---|
configuration | 14 |
Feature | Version | |
---|---|---|
configuration | 11 |
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: false
This property can be null.
Setting this property to null will set it to its default value.
Default value: 4
Property type documentation:
Represents a set of lyncOption.
This property can be null.
This property can be null.
Property type documentation:
This is not a user property. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form mailboxProperties.memberName. For example, mailboxProperties.directoryMoniker will return the user's directory moniker. Alternatively, one can use the '*' wildcard to select all properties of the user including these.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Setting this property to null will set it to its default value.
Default value: 0
This property can be null.
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: 0
This property can be null.
Property type documentation:
Represents a collection of strings.
This property can be null.
This property can be null.
This property can be null.
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
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of inheritedConfigurationIds.
List item type documentation:
Represents an inherited configuration ID collection. This type contains properties that indicate where the value was inherited from.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Property type documentation:
Represents the possible object types that can be specified in an inherited from property.
Required
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
This is not a user property. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form personalInformationProperties.memberName. For example, personalInformationProperties.assistantName will return the name of the user's assistant. Alternatively, one can use the '*' wildcard to select all properties of the user including these.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a phone number configuration value.
Required
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a phone number configuration value.
This property can be null.
Property type documentation:
Represents a phone number configuration value.
This property can be null.
Property type documentation:
Represents a phone number configuration value.
This property can be null.
Property type documentation:
Represents a phone number configuration value.
This property can be null.
Property type documentation:
Represents a phone number configuration value.
This property can be null.
Property type documentation:
Represents a phone number configuration value.
This property can be null.
Property type documentation:
Represents a phone number configuration value.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Feature | Version | |
---|---|---|
configuration | 5 |
This property can be null.
Property type documentation:
Represents an inherited property consisting of a collection of ConfigurationId's.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form securityRights.memberName. For example, securityRights.mobileOfficeUser will return the objects's mobile office security right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
The Interaction Center Server will combine these multiple skill assignments using the highest proficiency and desire to use values. For example, if the assignments are {"proficiency":10,
"desireToUse":14}
, {"proficiency":5,"desireToUse":24}
, and {"proficiency":42,"desireToUse":18}
, then the effective value used by the server will
be {"proficiency":42,"desireToUse":24}
. This same calculation is not performed for ICWS clients and as a result they must perform the calculation manually if they need to have the same
effective value as the Interaction Center Server.
This property can be null.
Property type documentation:
Represents a list of skill settings including effective and inherited values.
This property can be null.
Property type documentation:
Represents a set of skill settings.
List item type documentation:
Represents a skill setting.
This property can be null.
Property type documentation:
Represents a set of skill settings.
List item type documentation:
Represents a skill setting.
This property can be null.
Property type documentation:
Represents a set of skill settings.
List item type documentation:
Represents a skill setting.
This property can be null.
Property type documentation:
Represents a list of inherited skill settings.
List item type documentation:
Represents an inherited skill. This type contains properties that indicate where the value was inherited from.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Property type documentation:
Represents the possible object types that can be specified in an inherited from property.
Required
Property type documentation:
Represents a set of skill settings.
List item type documentation:
Represents a skill setting.
Setting this property to null will set it to its default value.
Default value: 0:00
Property type documentation:
Represents a collection of durations.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
IC Server
''.This property can be null.
This property can be null.
This property can be null.
Property type documentation:
This is not a user property. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form clientConfigurationProperties.memberName. For example, clientConfigurationProperties.showStatusInSystemTray will return true if the user's status should be shown in the Windows system tray. Alternatively, one can use the '*' wildcard to select all properties of the user including these.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited string property.
This is a read only property and can not be changed with PUT or POST operations.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This is a read only property and can not be changed with PUT or POST operations.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This is a read only property and can not be changed with PUT or POST operations.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This is a read only property and can not be changed with PUT or POST operations.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Feature | Version | |
---|---|---|
configuration | 7 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 4 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited integer property.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a collection of inherited integers.
List item type documentation:
Represents an inherited integer. This type contains properties that indicate where the value was inherited from.
Required
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
Property type documentation:
Represents the possible object types that can be specified in an inherited from property.
Required
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents a collection of phone numbers for the client to call if the agent is not available.
List item type documentation:
Represents a phone number for the client to call if the agent is not available.
Required
The phone number to call.Required
How long to ring the follow-me number before moving to the next number in the list or transferring the call to voice mail.Required
If true, than the call recipient will be required to enter their IC password to accept the call.Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents an inherited boolean property.
This property can be null.
Property type documentation:
Represents a list of utilization settings.
This property can be null.
Property type documentation:
Represents a set of utilization settings.
List item type documentation:
Represents a utilization setting.
Required
Feature | Version | |
---|---|---|
configuration | 14 |
Feature | Version | |
---|---|---|
configuration | 14 |
Required
Required
This property can be null.
Property type documentation:
Represents a set of utilization settings.
List item type documentation:
Represents a utilization setting.
This property can be null.
Property type documentation:
Represents a set of utilization settings.
List item type documentation:
Represents a utilization setting.
This property can be null.
Property type documentation:
Represents a list of inherited utilization settings.
List item type documentation:
Represents an inherited utilization. This type contains properties that indicate where the value was inherited from.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the possible object types that can be specified in an inherited from property.
Required
This property can be null.
Property type documentation:
Represents a set of utilization settings.
List item type documentation:
Represents a utilization setting.
This property can be null.
Setting this property to null will set it to its default value.
Default value: -25
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
List item type documentation:
Represents the user configuration object.
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 subscription's state.Property type documentation:
Provides additional detail for an error.
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.
List item type documentation:
A unified-message of type voicemail.
Required
The JSON type representing this option.Required
The unique identifier for the message.Required
The current state of the message.Required
The date/time stamp the message was received.Required
The party that sent the message.Required
The subject of the message.Required
A list of file attachment objects associated with the message.List item type documentation:
An update for a unified-message of type voicemail.
Required
The JSON type representing this option.Required
The unique identifier for the message.Required
The current state of the message.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 unique identifier of the voicemail message that the play update refers to.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 ID of the watched subscription.Required
List of IDs for workgroups that are targets.Required
Users in this workgroup whose activation changed, and their new activation state.Property type documentation:
Represents a collection of key/value pairs where each key is a string and each value is a boolean.
Required
The key identifying this pair.Required
The value of this pair.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.
List item type documentation:
Represents the workgroup configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form accessRights.memberName. For example, accessRights.viewUserQueue will return the objects's view user queue access rights. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: false
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: true
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form administrativeRights.memberName. For example, administrativeRights.masterAdministrator will return the objects's master administrator right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
Setting this property to null will set it to its default value.
Default value: -10
Setting this property to null will set it to its default value.
Default value: 0
Setting this property to null will set it to its default value.
Default value: [300, 600, 900, 1800, 3600, 7200, 14400, 28800]
Property type documentation:
Represents a collection of durations.
Setting this property to null will set it to its default value.
Default value: 14400
Setting this property to null will set it to its default value.
Default value: 0
Setting this property to null will set it to its default value.
Default value: [5, 10, 20, 30, 40, 50, 60, 120]
Property type documentation:
Represents a collection of durations.
Setting this property to null will set it to its default value.
Default value: 30
Setting this property to null will set it to its default value.
Default value: 30
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: [10, 20, 30, 45, 60, 90, 120, 240]
Property type documentation:
Represents a collection of durations.
Setting this property to null will set it to its default value.
Default value: 30
Setting this property to null will set it to its default value.
Default value: 30
Setting this property to null will set it to its default value.
Default value: [300, 600, 1200, 1800, 3600, 7200, 14400, 28800]
Property type documentation:
Represents a collection of durations.
Setting this property to null will set it to its default value.
Default value: 14400
Setting this property to null will set it to its default value.
Default value: 30
Setting this property to null will set it to its default value.
Default value: true
This property can be null.
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: [10, 20, 30, 45, 60, 90, 120, 240]
Property type documentation:
Represents a collection of durations.
Setting this property to null will set it to its default value.
Default value: 30
Setting this property to null will set it to its default value.
Default value: 10
This is a read only property and can not be changed with PUT or POST operations.
Setting this property to null will set it to its default value.
Default value: false
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents an inherited duration property.
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: true
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: 30
This property can be null.
Setting this property to null will set it to its default value.
Default value: 1
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: false
This property can be null.
Property type documentation:
Represents a list of monitoredMailbox configuration objects.
List item type documentation:
Represents the monitoredMailbox configuration object.
Setting this property to null will set it to its default value.
Default value: false
This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property is required to be present in POST operations.
This property can be null.
This property is required to be present in POST operations.
This property is required to be present in POST operations.
This property can be null.
Property type documentation:
Represents a collection of strings.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
Setting this property to null will set it to its default value.
Default value: false
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: 5
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: 0
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form securityRights.memberName. For example, securityRights.mobileOfficeUser will return the objects's mobile office security right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
Setting this property to null will set it to its default value.
Default value: <Default>
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a set of skill settings.
List item type documentation:
Represents a skill setting.
Feature | Version | |
---|---|---|
configuration | 14 |
Setting this property to null will set it to its default value.
Default value: [300, 600, 1200, 1800, 3600, 7200, 14400, 28800]
Property type documentation:
Represents a collection of durations.
Feature | Version | |
---|---|---|
configuration | 14 |
Setting this property to null will set it to its default value.
Default value: 14400
Feature | Version | |
---|---|---|
configuration | 14 |
Setting this property to null will set it to its default value.
Default value: [10, 20, 30, 45, 60, 90, 120, 240]
Property type documentation:
Represents a collection of durations.
Feature | Version | |
---|---|---|
configuration | 14 |
Setting this property to null will set it to its default value.
Default value: 14400
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: 0:00
Property type documentation:
Represents a collection of durations.
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
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: [{mediaType: 1, utilization: 100, maxAssignable: 1}, {mediaType: 2, utilization: 100, maxAssignable: 0}, {mediaType: 3, utilization: 100, maxAssignable: 0}, {mediaType: 4, utilization: 100, maxAssignable: 0}, {mediaType: 5, utilization: 100, maxAssignable: 0}, {mediaType: 7, utilization: 100, maxAssignable: 0}, {mediaType: 8, utilization: 100, maxAssignable: 0}]
Property type documentation:
Represents a set of utilization settings.
List item type documentation:
Represents a utilization setting.
This property can be null.
This property can be null.
Property type documentation:
This is not a workgroup property. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of it's members, use the form workgroupMailboxProperties.memberName. For example, workgroupMailboxProperties.directoryMoniker will return the workgroup's directory moniker. Alternatively, one can use the '*' wildcard to select all properties of the workgroup including these.
This property can be null.
This property can be null.
Setting this property to null will set it to its default value.
Default value: 0
Setting this property to null will set it to its default value.
Default value: [30, 60, 900, 1800, 3600, 14400, 86400, 172800]
Property type documentation:
Represents a collection of durations.
Setting this property to null will set it to its default value.
Default value: 14400
This property can be null.
Property type documentation:
Represents a collection of configurationId's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
List item type documentation:
Represents the workgroup configuration object.
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.
List item type documentation:
Represents the wrapUpCategory configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Setting this property to null will set it to its default value.
Default value: false
This is a read only property and can not be changed with PUT or POST operations.
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
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.
This property can be null.
This property can be null.
Setting this property to null will set it to its default value.
Default value: false
List item type documentation:
Represents the wrapUpCategory configuration object.
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.
List item type documentation:
Represents the wrapUpCode configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
This is a read only property and can not be changed with PUT or POST operations.
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
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 the wrapUpCode configuration object.
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.A server-sent event endpoint for message representations. Each server-sent message is a single message representation.
This endpoint is equivalent in functionality to the GET method with same resource URL, but the response is an implementation of the W3C Server-Sent Events Recommendation.
Applications should not utilize this event source and the GET method for retrieving messages in a single session. For more information on handling message retrieval, see Retrieving Messages.
Feature | Version | |
---|---|---|
messaging | 2 |
Required
The ININ session ID 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.Indicates that the client will send a periodic request as a heartbeat. This query string does not require a value. The required request to provide a heartbeat is POST /icws/{sessionId}/messaging/heartbeat.
Feature | Version | |
---|---|---|
messaging | 3 |
Multiple options:
The value can be assigned any of the following options.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.
List item type documentation:
Represents the accessControlGroup configuration object.
List item type documentation:
Represents the accessControlGroup configuration object.
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 accountCodesConfiguration configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
Setting this property to null will set it to its default value.
Default value: false
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.
List item type documentation:
Represents the accountCode configuration object.
List item type documentation:
Represents the accountCode configuration object.
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.
List item type documentation:
Represents the action configuration object.
List item type documentation:
Represents the action configuration object.
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.
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
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:
A lists of AlertNotifications.
List item type documentation:
Represents the data sent for a given alert. The alert notification contians the data about what alert has changed state, its new state and value.
Required
Gets the ID of the AlertDefinition assoicated with this notifiction.Required
Gets the ID of the AlertRule that the alert was raised on.Required
Gets a value indicating whether this AlertNotification is cleared.Required
Gets the received date and time.Required
Gets the statistic value that triggered this alert notification.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 assistance ID for this assistance request.Property type documentation:
Represents a list of message text items for the assistance request.
List item type documentation:
Represents a message text entry for an assistance request.
Required
The message text.Required
The user ID of the participant that added the message text.Required
The date and time the message text was added.Property type documentation:
Represents a list of assistance participants.
List item type documentation:
Describes a participant associated with an assistance item.
Property type documentation:
Represents a list of assistance participants.
List item type documentation:
Describes a participant associated with an assistance item.
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:
Represents a list of assistance requests.
Property type documentation:
Represents a list of assistance requests.
Feature | Version | |
---|---|---|
interactions | 10 |
Feature | Version | |
---|---|---|
interactions | 10 |
Feature | Version | |
---|---|---|
interactions | 10 |
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 subscription's state.Property type documentation:
Provides additional detail for an error.
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
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.
List item type documentation:
Represents the audioSource configuration object.
List item type documentation:
Represents the audioSource configuration object.
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 ID of the campaign the agent is logged in to.Required
This identifies the rule or supervisor who initiated the agent's campaign login.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 campaign IDs for which a campaign logoff was requested.Required
This identifies the rule or supervisor who initiated the agent's campaign logout request.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 JSON type representing this option.Required
The name of the campaign.Required
The ID of the campaign.Required
The workgroup associated with the campaign.Feature | Version | |
---|---|---|
dialer | 3 |
Feature | Version | |
---|---|---|
dialer | 3 |
Feature | Version | |
---|---|---|
dialer | 3 |
Feature | Version | |
---|---|---|
dialer | 6 |
Required
The JSON type representing this option.Required
The name of the campaign.Required
The ID of the campaign.Required
The ID of the removed campaign.Required
Specifies if the agent has the "Logon Campaign" security right to choose which campaigns to log in to. Agents without this right are automatically logged in to all campaigns they are eligible for. After agents are logged in,ready-for-calls
still needs to be called to have calls routed to them.
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 agent's current break status.Feature | Version | |
---|---|---|
interactions | 8 |
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 ID of the interaction this message corresponds to.Required
The target for this callback.Required
A message that describes the reason for this callback.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
Required
This is the parameterTypeId.Required
Property type documentation:
Represents a collection of strings.
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 ID of the interaction this message corresponds to.Required
Required
The chat member responsible for this chat text.Multiple options:
The value can be assigned any of the following options.Required
The type of this chat member.Required
The display name of the chat member.Required
The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.Required
The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.Required
The JSON type representing this option.Required
The type of this chat member.Required
The display name of the chat member.Required
The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.Required
The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.Required
Indicates if this chat member is typing.Required
The chat text.This property can be null.
Required
The timestamp associated with the chat text.Feature | Version | |
---|---|---|
interactions | 10 |
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 ID of the interaction this message corresponds to.Required
Required
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.
List item type documentation:
Represents the clientButton configuration object.
List item type documentation:
Represents the clientButton configuration object.
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.
List item type documentation:
Represents the clientConfigurationTemplate configuration object.
List item type documentation:
Represents the clientConfigurationTemplate configuration object.
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.
List item type documentation:
Represents the clientTemplate configuration object.
List item type documentation:
Represents the clientTemplate configuration object.
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 state of the connection before the change.Required
The state of the connection after the connection change.Required
A description of the condition that caused the change in connection state.newConnectionState
is set to down
, an unspecified value should be
assumed to be false
.
Feature | Version | |
---|---|---|
connection | 3 |
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
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
True if the result count exceeds the maximum number of results specified.This property can be null.
Required
The ID of the recording.Feature | Version | |
---|---|---|
quality-management | 4 |
Required
Interaction ID of the recording.This property can be null.
Required
The recording time in UTC.This property can be null.
Required
The version of the recording.This property can be null.
This property can be null.
Bit Flags
The session user's rights for the recording.Feature | Version | |
---|---|---|
quality-management | 4 |
Property type documentation:
Recording security policy rights bit flags.
This property can be null.
Required
The scorecard result data for this recording.Required
The scorecard ID.Required
The scorecard's questionnaire ID.This property can be null.
This property can be null.
This property can be null.
Required
The UTC time this scorecard was last modified.Required
The scorecard's scoring state.This property can be null.
Required
The scorecard's current score percentage.Required
The state of the scorecard's signature.Required
The state of this scorecard for calibration purposes.This property can be null.
This property can be null.
This property can be null.
Required
The unique ID for the completed survey.Required
The ID of the survey.This property can be null.
This property can be null.
This object is received when Process Automation Server (PAS) is instructing the application to close the work item instance for any reason. The message may be received under a varierty of circumstances ranging from a user pressing a button that caused the work item to end, to Process Automation Server forcing the page to close because the work item is in error, etc..
Note that it is possible for a process to go into error after a work item is picked up but before the first page of the work item is displayed. For example, an error could occur while running an action at the start of a work item, or before showing the first page of the work item. In such cases, the event to close the work item because of a process error will still be received even though an event to show a page was never received.
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
This property indicates the ID of the work item instance from which this message was received.
This property indicates the reason why the work item page is being closed.
This object is returned after Process Automation Server (PAS) has completed the processing of page command. The object is returned regardless of the commandType, regardless of whether there was or was not any data to be saved, and regardless of whether data to be saved was valid or invalid.
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
This property indicates the ID of the work item instance from which this message was received.
Required
This property contains the same token that was included in the response when the page command was queued. It can be used to correlate this event message to the request that caused the caused the event to occur.
Required
This property is null if the queued page command completed successfully, or is an error object if the page command failed. For translating the error codes, 0 equals unknown error, 1 equals invalid data items, and 2 equals an invalid command ID.
This property can be null.
Property type documentation:
Provides additional detail for an error.
This property contains the list of data that was invalid and could not be saved by Process Automation Server (PAS). Data that was valid and successfully saved is not included within this list.
Property type documentation:
This object defines a list of dataReference objects.
This property indicates the fully-scoped ID of the data that is being referenced.
See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.
This object is received when it is time to show a new page for the work item instance. A work item instance will generally receive one of these messages soon after the subscription for the current page is established, and may receive another one of these messages soon after a Save or Cancel command is sent.
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
This property indicates the ID of the work item instance from which this message was received.
Required
This property indicates the current Work Item Dynamic Details of the work item instance for which the page is being displayed.
Required
This property indicates the ID of the specific page instance that is being shown as the current page. Each time a command is sent to PAS for the current page, that command request must also include this ID.
This property contains the data values, if any, used for the indicated page. The string value is to be JSON formatted per the IPA Device Independent Work Item Data Value Format.
Property type documentation:
This class defines the structure that contains the list of runtime data values, item selections, etc.
Required
This property contains meta infomation about the data values.
Required
The JSON type representing this option.Required
This field specifies the type of payload that is described by the object that contains this meta object.
The value of this field will always be "dataValue" for the data values received as part of a show page event message.
Required
This field contains a string value that looks like a typical #.#.#.# version string. The numbers represented in this string may change over time as new features are added to IPA.
The current value for formatVersion
is 3.0.0.0
.
This property contains the list of runtime data values that described the data object instances used on the work item page.
This property can be null.
Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of boolean values to use for this boolean data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a boolean value to use for this data type object instance . If this field is not emitted or if its value is null, then an not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of complex values to use for this items collection for complex data collection instance. If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a complex object value to use for this data object instance collection item . If this field is not emitted or if it value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a complex object value, includes values for the object's properties and may include a unique ID depending on the context in which this class is used.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a complex object value to use for this data type object instance . If this field is not emitted or if it value is null, then not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a complex object value, includes values for the object's properties and may include a unique ID depending on the context in which this class is used.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of currency values to use for this currency data object instance collection . If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a currency value to use for this data type object instance . If this field is not emitted or if its value is null, then not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a currency value, which includes both an amount and a currency code.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this date data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this date data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this date-time data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this date-time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this decimal data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this decimal data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this duration data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this duration data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this long data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this long data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of mailbox values to use for this mailbox data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a mailbox value to use for this data type object instance . If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a mailbox value, which includes both a string value and a mailbox type.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this skill data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a skill value is simply the name of the skill.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this skill data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a skill value is simply the name of the skill.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this string data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a string value is simply the string itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this string data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a string value is simply the string itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this time data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this uri data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a URI value is simply the URI itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this uri data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a URI value is simply the URI itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of user queue values to use for this user queue data object instance collection . If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a user queue value to use for this data type object instance . If this field is not emitted or if its value is null, then not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a user queue value, which includes both a value (username) and a display name.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this workgroup queue object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this workgroup queue data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
This property contains the lists of selected items for the various controls in the work item page definition, such as a grid, that may be used as single-select or multi-select controls. If this property is not emitted or is null or empty, then the work item page definition must not contain any grids configured for use as selection controls.
It should be noted that the drop list control does not use this same selections property. This is because the drop list is always single select to a collection of basic or simple types (no complex types), and always selects by value and not by object instance ID or unique ID of a complex object.
Also, note that this selections field only applies in the context of a specific page, and does not apply in the context of multiple pages, an entire work item or entire process. Therefore, it can optionally be used in the show page event or when sending a page command, but is not used and will be ignored when launching a process.
This property can be null.
Required
This field indicates the fully scoped GUID that is the ID or the collection that contains the list if items (singleton or complex) from which a selection may be made.
For example, this could be the ID for a collection of basic or simple types displayed in a single-column grid. Or, it could be the ID of a collection that contains a complex object for each row that is to be displayed in a multi-column grid. Either way, this is the ID of a collection of all of the items, not just the selected items.
See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.
Required
This field indicates the fully scoped GUID that is the ID of the variable that holds the selected item (single select mode), or the ID of the collection that holds the list of selected items (multi-select mode).
When configured to select "by unique identifier", the variable indicated by this ID will be a string singleton (single-select mode) or string collection (multi-select mode), and only a string representation of the uniqueId(s) of the selected item(s) will be in that variable.
When configured to select "by data type", the variable indicated by this ID will be a singleton (single-select mode) or collection (multi-select mode) of the same type indicated by the sourceId field, which could be a basic, simple or complex type. And, in this case, a complete copy of each select item is stored in the variable indicated by this destination field; not just the uniqueId(s).
See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.
This field holds the list of simple GUIDs that are the IDs of the selected items, regardless of whether configured to select "by data type" or "by unique identifier".
This field is always a collection regardless of whether single-select mode or mult-select mode is being used. But, at most one item can exist in this list for single-select mode, whereas multiple items can exist in this list for mult-select mode.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This property can be null.
Required
This property contains the URL where the page definition and data definitions can be found for the current page of this work item instance. The page and data definitions for the specific revision of the specific page definition of the specific process definition are wrapped into a JSON file at this location.
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
DataPop information for a call. The specific attributes vary for preview and non-preview calls.Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.Required
The interaction ID for the call being popped.Required
ID of the campaign associated with the call.Required
Contact data for the call.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Required
Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.Required
Specifies if this call can be dispositioned as rescheduled for a specific agent.Required
The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.Required
Dialing mode for the call.Property type documentation:
Specifies constants that indicate the dialing mode for a Dialer call.
Required
The JSON type representing this option.Required
The interaction ID for the call being popped.Required
ID of the campaign associated with the call.Required
Contact data for the call.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Required
Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.Required
Specifies if this call can be dispositioned as rescheduled for a specific agent.Required
The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.Required
Dialing mode for the call.Property type documentation:
Specifies constants that indicate the preview dialing mode for a Dialer call.
Required
Indicates whether Dialer has been requested to place the preview call. If true, attempts to call theplace-preview-call
method fail.
previewTimeout
is the IC server time when the preview countdown expires. Compare this time to the server clock time via GET /icws/connection/server-time to account for client/server time drift. The server does not support initiating a preview call after the countdown is reached. If that functionality is required, it must be included in the client application.
Required
Indicates whether the agent is allowed to skip this preview call. To skip a preview call, call thedisposition
method with a wrapup label of "Skipped - Agent Skip".
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.
Feature | Version | |
---|---|---|
wfm | 4 |
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 defaultUser configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form accessRights.memberName. For example, accessRights.viewUserQueue will return the objects's view user queue access rights. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form administrativeRights.memberName. For example, administrativeRights.masterAdministrator will return the objects's master administrator right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
Represents an inherited string property.
This property can be null.
Property type documentation:
Represents an inherited duration property.
This property can be null.
Property type documentation:
This is not a property of them. As a result, setting to NULL will have no effect. Additionally, selecting it will result in an error. To select one of its members, use the form securityRights.memberName. For example, securityRights.mobileOfficeUser will return the objects's mobile office security right. Alternatively, one can use the '*' wildcard to select all properties of the object including these.
Setting this property to null will set it to its default value.
Default value: 0
Setting this property to null will set it to its default value.
Default value: -25
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.
List item type documentation:
Represents the dialPlanClassification configuration object.
List item type documentation:
Represents the dialPlanClassification configuration object.
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 bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
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 subscription's ID.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
New effective station information.This property can be null.
Required
The ID of the station for the session.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
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 ID of the interaction this message corresponds to.Required
Indicates whether or not the email can be edited by the current user.Required
Required
The JSON type representing this option.Required
The sender's email address.Required
The email bodies.Required
The timestamp of when the email was received.Feature | Version | |
---|---|---|
interactions | 9 |
Required
The JSON type representing this option.Required
The subject of the attached message.Required
The identifier used to retrieve the attached message.Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 12 |
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
The ID of the interaction this message corresponds to.Required
The content of the email.Feature | Version | |
---|---|---|
interactions | 9 |
Feature | Version | |
---|---|---|
interactions | 9 |
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 subscription's state.Property type documentation:
Provides additional detail for an error.
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
The ID of the interaction this message corresponds to.Required
The name of the file being uploaded.Required
Indicates file upload success.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 subscription's state.Property type documentation:
Provides additional detail for an error.
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.
List item type documentation:
A unified-message of type fax.
Required
The JSON type representing this option.Required
The unique identifier for the message.Required
The current state of the message.Required
The date/time stamp the message was received.Required
The party that sent the message.Required
The subject of the message.Required
A list of file attachment objects associated with the message.List item type documentation:
An update for a unified-message of type fax.
Required
The JSON type representing this option.Required
The unique identifier for the message.Required
The current state of the message.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 identifier of the object for the notification.
The value represented by this property should be treated as case-insensitive.
Required
The identifier of the event for the notification.
The value represented by this property should be treated as case-insensitive.
Required
A list of strings that were provided by the handler which sent the notification.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.
List item type documentation:
Contains history information for an interaction.
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.
List item type documentation:
Represents the imageResource configuration object.
List item type documentation:
Represents the imageResource configuration object.
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:
A collection of Interaction Alerting event details.
Required
The unique identifier of the Interaction that is alerting.Required
The type of Interaction that is alerting. This will be valued with the 'objectType' Interaction attribute value.Required
The name associated to the party that initiated the Interaction.Required
The telephone number, telephone extension, email address, or other such origin of the Interaction.Required
Indicates the type of Interaction Alerting event that is being raised.Required
Specifies whether the Alerting event is instructing the consumer to begin, or to end, alerting the end user.Required
Indicates whether the alerting Interaction should be picked up automatically.Property type documentation:
A queueId containing the queue type and its name.
Required
The type of queue being identified.Required
The name of the queue being identified.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.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 interaction's ID.Required
A dictionary of attributes subscribed to, and their corresponding values.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.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 interaction's ID.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 interaction's ID.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 interaction's ID.Required
The new interaction ID after the morph.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 interactionRecorderConfiguration configuration object.
Feature | Version | |
---|---|---|
configuration | 11 |
This property can be null.
This property can be null.
Feature | Version | |
---|---|---|
interactions | 13 |
Feature | Version | |
---|---|---|
interactions | 13 |
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 interaction's ID.Required
The new snippetRecording Id.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
The name of the job.
Required
The user ID that was used to submit the job.
Required
The unique ID associated with the job. This value is set by the server at the time the job is created.
Required
The site ID associated with the user who submitted the job.
The datetime the job was submitted.
The datetime the job was queued.
The datetime the job was canceled.
The datetime the job finished.
The datetime the job started.
The datetime the job failed.
The datetime the job last changed state.
The user ID that cancelled the job.
The output path where the extracted files were saved to.
Additional error information.
When the job has been submitted.
When the job has been queued.
When the job has been started.
If the job failed.
If the job was canceled.
When the job has finished.
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.
List item type documentation:
Represents the keywordSet configuration object.
List item type documentation:
Represents the keywordSet configuration object.
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.
This property contains the list of processes definitions that have just become launchable by the current user. The process may have just been published or activated, the user may have just been granted the appropriate ACLs, etc.
Property type documentation:
This object defines a list of processDefinitionDescription objects.
List item type documentation:
This object contains information that identifies and describes a specific revision of a process definition.
This property contains the list of processes definitions that are already launchable by the current user, but just had a revision, name or description change.
Property type documentation:
This object defines a list of processDefinitionDescription objects.
List item type documentation:
This object contains information that identifies and describes a specific revision of a process definition.
This property contains the list of IDs for the process definitions that were previously launchable by the current user, but are no longer launchable by that user. The process may have been deactivated or deleted, the user may no longer have the appropriate ACLs, etc.
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.
List item type documentation:
Represents the layout configuration object.
List item type documentation:
Represents the layout configuration object.
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
Indicates whether or not the license is assigned to the user. An assigned license has not necessarily been acquired.
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.
Feature | Version | |
---|---|---|
configuration | 12 |
Setting this property to null will set it to its default value.
Default value: false
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
The ID of the campaign.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
Id of the campaign for which manual outbound call was initiated.Required
Id of the agent that initiated the manual outbound call.Required
Dialer Identity of the manual outbound call.Required
Manual outbound call status.Required
Contact record was excluded by the campaign filter.Required
Contact was zone blocked.Required
Agent initiating the call does not have the skills necessary.Required
The number of calls for the contact reached the daily limit.Required
Minimum spacing between calls is not satisfied.Required
Contact does not belong to the campaign initiating the call.Required
Contact is blocked by Do-Not-Call policy.Required
Contact record was excluded by the campaign query time filter.Required
A flag indicating the phone number associated with the call has been previously dialed.Required
The status of the record when uncallable.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 identifier for a memo.Required
A memo.The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}
.
Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.
Requests for PNG memo icons support an optional iconSize
parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16
. The default iconSize is 32 without this parameter.
Required
The identifier for a memo.Required
A memo.The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}
.
Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.
Requests for PNG memo icons support an optional iconSize
parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16
. The default iconSize is 32 without this parameter.
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
A count of waiting (unread) messages. When this field is zero there are no waiting messages.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 subscription's state.Property type documentation:
Provides additional detail for an error.
Feature | Version | |
---|---|---|
dialer | 3 |
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 state of the connection before change.Required
The state of the connection after the connection change.Required
A description of the condition that caused the change in connection state.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.
This property indicates the current run state of Process Automation Server (PAS).
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.
List item type documentation:
Represents the passwordPolicy configuration object.
List item type documentation:
Represents the passwordPolicy configuration object.
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
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.
List item type documentation:
Represents the position configuration object.
List item type documentation:
Represents the position configuration object.
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 problemReporter configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents a collection of strings.
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.
List item type documentation:
Represents the queueColumn configuration object.
List item type documentation:
Represents the queueColumn configuration object.
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 subscription ID that this message correlates to.List item type documentation:
An interaction containing the interaction ID and its interaction attribute values. In addition it contains a possible conference parent interaction ID.
Required
The interaction ID of the interaction.Required
A dictionary of attributes subscribed to, and their corresponding values.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.List item type documentation:
An interaction containing the interaction ID and its interaction attribute values.
Required
The interaction ID of the interaction.Required
A dictionary of attributes subscribed to, and their corresponding values.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Feature | Version | |
---|---|---|
queues | 2 |
Feature | Version | |
---|---|---|
queues | 2 |
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 subscription's state.Property type documentation:
Provides additional detail for an error.
Required
The subscription ID that this message correlates to.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.
List item type documentation:
Represents the recordingBeepTone configuration object.
List item type documentation:
Represents the recordingBeepTone configuration object.
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 Subscription's Id.Required
This is same as what is provided in subscription parameters. eg. indivId, orgId, locId.Required
The Interaction's Id.Required
The JSON type representing this option.Required
Participant's indivID.Required
Participant's display name.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.
List item type documentation:
Represents the responseManagementDocument configuration object.
List item type documentation:
Represents the responseManagementDocument configuration object.
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 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
This property can be null.
Property type documentation:
Provides additional detail for an error.
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.
List item type documentation:
Represents the role configuration object.
List item type documentation:
Represents the role configuration object.
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.
List item type documentation:
Represents the salesforceCTIConfiguration configuration object.
List item type documentation:
Represents the salesforceCTIConfiguration configuration object.
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.
List item type documentation:
Represents the schedule configuration object.
List item type documentation:
Represents the schedule configuration object.
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.
List item type documentation:
Represents the secureInputForm configuration object.
List item type documentation:
Represents the secureInputForm configuration object.
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.
List item type documentation:
Represents the serverParameter configuration object.
List item type documentation:
Represents the serverParameter configuration object.
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 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
Campaign ID for Base Script definition.Required
Base Script form definition.Required
Collection of pages used within a Base Script.Required
Name of the Base Script page.Required
Form controls for a Base Script page.Required
Database column linked to control.Required
Label of the Base Script page.Required
Specifies whether control has read-only property set.Required
Specifies type of control to display.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Required
The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.Required
Name of a disposition choice the agent can select from at the end of a call.Required
The wrap-up category assigned to the call.Required
The wrap-up code assigned to the call.Required
Specifies if a call is marked as abandoned.Required
Record status assigned for this disposition.Required
Specifies if this disposition is considered a contact.Required
Static text of the Base Script page.Required
Foreground color of the Base Script page.Required
Background color of the Base Script page.Required
Miscellaneous options configured for a Base Script.Required
Specifies whether this base script allows agents to request break.Required
Specifies whether this base script allows agents to skip calls.Required
Specifies whether this base script allows agent-owned callbacks.Required
Specifies whether this base script should use 24-time format.Required
Specifies whether this base script should automatically pick-up alerting calls.Required
Specifies whether this base script allows scheduling.Required
Specifies whether this base script allows auto disconnect on disposition.Required
Specifies whether this base script allows editing of Number to Dial.Required
Specifies whether this base script allows agents to place Additional Followup calls.Required
Specifies whether this base script allows editing Additional Call Numbers.Required
Specifies whether this base script allows overriding DNC block for manual calls.Required
Specifies whether this base script allows overriding zone block for manual calls.Required
Specifies whether this base script allows overriding skills block for manual calls.Required
Specifies whether this base script allows overriding daily limit block for manual calls.Required
Contains list of allowable extensions to dial.Required
Object display name.Required
Extension number.Required
Type of the object [Station, User, Workgroup, StationGroup or Attendant].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.
List item type documentation:
Represents the skillCategory configuration object.
List item type documentation:
Represents the skillCategory configuration object.
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.
List item type documentation:
Represents the skill configuration object.
List item type documentation:
Represents the skill configuration object.
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
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
This property can be null.
Property type documentation:
Provides additional detail for an error.
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 station connection information after the change.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
A list of statistic categories that make up the statistic catalog.Required
The ID of the statistic category.Required
A user friendly string for display purposes.Required
A description of the statistic category.Required
A list of statistic definitions that make up this statistic category.Required
The ID of the statistic definition.Required
A user friendly string for display purposes.Required
A description of the statistic definition.Required
The display string to define the measurement of units.Required
A list of required parameter definitions.Required
The types of parameters required in a specific order.Required
Gets a value indicating whether this should be suppressed from direct presentation to the user.Required
Additional data that is associated with this statistic definition.Required
The precision of the data.Required
The measurement of units for this statistic definition.Feature | Version | |
---|---|---|
statistics | 4 |
Required
Additional flags that may be set to modify a statistic definition.Required
Required
The ID of the drill down.Required
The hint as to what the format is of the drill down data.Required
The string that gives a hint as to what this drill down data refers to.Required
A list of access rights that the user should have in order to see this catalog.Required
A list of the licenses that the user should have in order to see this catalog.Required
A list of parameter type definitions that represent additional details for a parameter type object.Required
The ID of the parameter type.Required
A user friendly string for display purposes.Required
The description of the associated parameter type.Required
Each of the access control lists returned by this property could be used to fetch parameter values that the Session user is allowed to use. When retrieving available parameter values associated with this ParameterTypeDefinition, the values will be filtered to only include items allowed by these access control lists.Required
True if the display order should be preserved; otherwise false.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.
List item type documentation:
Represents the statisticParameterGroup configuration object.
List item type documentation:
Represents the statisticParameterGroup configuration object.
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
The value type of the statistic.This property can be null.
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 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
List of changes to a user's status regarding the rights granted to the user.Required
The unique identifier for this user status entry. This is the IC User name.A list of added status message IDs that the user has rights to.
The values represented in this property should be treated as case-insensitive.
A list of status message IDs the user no longer has rights to.
The values represented in this property should be treated as case-insensitive.
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.
List item type documentation:
Represents the structuredParameter configuration object.
List item type documentation:
Represents the structuredParameter configuration object.
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 system configuration object.
\
', '"
', or '|
'.This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
This property can be null.
This property can be null.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This is a read only property and can not be changed with PUT or POST operations.
Feature | Version | |
---|---|---|
configuration | 3 |
This property can be null.
Property type documentation:
Represents a collection of idDisplayNames's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
This property can be null.
Property type documentation:
Represents a collection of idDisplayNames's.
List item type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
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.
List item type documentation:
Represents the systemParameter configuration object.
List item type documentation:
Represents the systemParameter configuration object.
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 ID of the watched subscription.Required
The ID of the user of this activation record.Required
Workgroups for which the user's activation changed, and the new activation state.Property type documentation:
Represents a collection of key/value pairs where each key is a string and each value is a boolean.
Required
The key identifying this pair.Required
The value of this pair.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
List item type documentation:
A single user status.
User statuses only contain the statusId
property and additional members specific to a user.
Clients need to retrieve
status messages
in order to map to a status message (for messageText etc.) using the statusId
property.
Required
The unique identifier for this user status to update. This is the IC User name.
Required
The ID of the status message that the specified user is currently set to.
The value represented by this property should be treated as case-insensitive.
The status message notes set by user.
The forward number set by user.
The user status until time.
This property can be null.
Property type documentation:
Clients must supply a complete UTC dateTime, regardless of the user specifying only date or only time. The hasDate and hasTime members have to do with UI, not the completeness of untilDateTime. If a user specifies only a date, clients must use the UTC dateTime converted from midnight local time for that date. If a user specifies only a time, clients must use the UTC dateTime converted from today's date at that local time.
This property indicates whether the user is on phone.
This property is updated when status on onPhone changes.
This property is update when user status changes.
The stations on which the user is logged in.
The name of the icServers to which the user is connected to.
The name of the server that is providing status for this user.
Indicates whether or not the user is logged into a station.
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
List of previous users' information.Required
Previous status message identifier defined from StatusMessageList.
The value represented by this property should be treated as case-insensitive.
Required
Previous status notes.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.
List item type documentation:
Represents the user configuration object.
List item type documentation:
Represents the user configuration object.
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 subscription's state.Property type documentation:
Provides additional detail for an error.
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.
List item type documentation:
A unified-message of type voicemail.
Required
The JSON type representing this option.Required
The unique identifier for the message.Required
The current state of the message.Required
The date/time stamp the message was received.Required
The party that sent the message.Required
The subject of the message.Required
A list of file attachment objects associated with the message.List item type documentation:
An update for a unified-message of type voicemail.
Required
The JSON type representing this option.Required
The unique identifier for the message.Required
The current state of the message.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 unique identifier of the voicemail message that the play update refers to.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 ID of the watched subscription.Required
List of IDs for workgroups that are targets.Required
Users in this workgroup whose activation changed, and their new activation state.Property type documentation:
Represents a collection of key/value pairs where each key is a string and each value is a boolean.
Required
The key identifying this pair.Required
The value of this pair.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.
List item type documentation:
Represents the workgroup configuration object.
List item type documentation:
Represents the workgroup configuration object.
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.
List item type documentation:
Represents the wrapUpCategory configuration object.
List item type documentation:
Represents the wrapUpCategory configuration object.
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.
List item type documentation:
Represents the wrapUpCode configuration object.
List item type documentation:
Represents the wrapUpCode configuration object.