McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 223

↗ View in doc context
page
223
source
unity-connection/rest-api/cupi/cupi.md
chunk_id
unity-connection::rest-api::cupi::cupi::189

To retrieve a specific Alternate Name by its object ID: GET http://<connection-server>/vmrest/alternatenames/<objectid> Searching 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. Creating 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"?> <AlternateName> <FirstName>Mike</FirstName> <LastName>Wholebert</LastName> <GlobalUserObjectId>bde24d71-95fa-4ba8-bf1b-0e19a4e9a68b</GlobalUserObjectId> </AlternateName> When creating Distribution Lists, Private Lists, or VPIM Locations, only the FirstName field is used to provide the Alternate Name Updating The following is an example of a PUT request that modifies the First Name and Last Name of an existing Alternate Name: Cisco Unity Connection Provisioning Interface (CUPI) API 191 Cisco Unity Connection Provisioning Interface (CUPI) API for User Account Settings Searching