Cisco Unity Connection Provisioning Interface (CUPI) API -- Alternate Names

From DocWiki

(Difference between revisions)
Jump to: navigation, search
m (1 revision)

Latest revision as of 00:05, 14 December 2010

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


About Alternate Names

This page contains information on how to use the API to create, list, update, and delete Alternate Names. Alternate Names are shared by users, contacts, distribution lists, private lists, and VPIM locations. Each of these objects can have Alternate Names associated with them.

Listing and Viewing

The following is an example of a GET that lists all Alternate Names:

GET http://<connection-server>/vmrest/alternatenames

The following is the response from the above GET request:

<?xml version="1.0" encoding="UTF-8"?>
<AlternateNames total="5">
    <FirstName>privut lyst</FirstName>
    <FirstName>vpim lokaychion aye</FirstName>

In this example, the first Alternate Name in the list belongs to a user as denoted by the GlobalUserObjectId field. The second Alternate Name belongs to a Distribution List, and so on.

For Distribution Lists, Private Lists, and VPIM Locations, only the FirstName field is used to provide the Alternate Name. These objects only have a single Display Name, they do not have separate first and last names.

To retrieve a sorted list of all Alternate Names, add the following query parameter:

sort=(column [asc | desc])

For example, to retrieve a list of all Alternate Names sorted by Object Id in ascending order:

GET http://<connection-server>/vmrest/alternatenames?sort=(objectid%20asc)

To retrieve a specific Alternate Name by its object ID:

GET http://<connection-server>/vmrest/alternatenames/<objectid>


To retrieve a list of Alternate Names that meet a specified search criteria, add the following query parameter to a GET:

query=(column [is | startswith] value)

For example, to find all Alternate Names with a GlobalUserObjectId that equals "bde24d71-95fa-4ba8-bf1b-0e19a4e9a68b" (this is a search to find all Alternate Names for a specific User):

GET http://<connection-server>/vmrest/alternatenames?query=(globaluserobjectid%20is%20bde24d71-95fa-4ba8-bf1b-0e19a4e9a68b)

To find Alternate Names for various objects, use the following object id columns:

  • For Users, use GlobalUserObjectId.
  • For Contacts, use ContactObjectId.
  • For Distribution Lists, use DistributionListObjectId.
  • For Private Lists, use PersonalGroupObjectId.
  • For VPIM Locations, use LocationObjectId.


The required fields for creating an Alternate Name are a parent object id, a First Name, and for some objects a Last Name. To determine what parent object id column to use to create the new Alternate Name, use the list found in the Searching section above. For example, if you are creating an Alternate Name for a User, then a GlobalUserObjectId needs to be provided.

The following is an example of a POST that creates an Alternate Name for a User with a First Name of "Mike" and a Last Name of "Wholebert" whose Global User Object Id is "bde24d71-95fa-4ba8-bf1b-0e19a4e9a68b":

POST http://<connection-server>/vmrest/alternatenames
<?xml version="1.0" encoding="UTF-8"?>

When creating Distribution Lists, Private Lists, or VPIM Locations, only the FirstName field is used to provide the Alternate Name


The following is an example of a PUT request that modifies the First Name and Last Name of an existing Alternate Name:

PUT http://<connection-server>/vmrest/alternatenames/<objectid>
<?xml version="1.0" encoding="UTF-8"?>


The following is an example of a DELETE request that deletes an Alternate Name:

DELETE http://<connection-server>/vmrest/alternatenames/<objectid>

Rating: 5.0/5 (1 vote cast)

Personal tools