Jump to: navigation, search

Internal API Business Attributes

The URI /internal-api/business-attributes will be used to access business attributes configured for the Configuration Server tenant which has been associated with the current contact center. Note that there is no URI to retrieve a single business attribute—that is, each call will return an array of all business attributes.

Attributes

The following attributes will be available for each BusinessAttribute object:

Attribute Type Description
name String The name of the business attribute.
description String The description of the business attribute.
displayName String The business attribute's display name.
userProperties KeyValueCollection A collection of key/value pairs describing additional user properties.
values Array of BusinessAttribute An array of business attribute objects.
default Boolean Specifies whether this is the default attribute.

Example

The following example retrieves all business attributes:

GET /internal-api/business-attributes
{
       businessAttributes:[{
		"name":"xxxx"
		"displayName":"xxxx"
		"description":"Xxxx"
		"userProperties":[
			{
				"name":"section"
				"value":[{"name":"name1", "value":"value1"}]
			}
       		]
		"values":[
			{
				"name":"xxx"
				"displayName":"xxxx"
				"description":"xxxx"
				"userProperties":[…]
			}
		]
                }, ...         
           ]
}
This page was last edited on June 10, 2013, at 16:04.
Comments or questions about this documentation? Contact us for support!