User Data Services API

Overview

The User Data Services (UDS) API is a REST-based set of operations that provide authenticated access to user resources and entities, such as user's devices, subscribed services, speed dials, and much more from the Cisco Unified Communications Manager (Unified CM) configuration database.

To learn more about UDS, visit What is UDS?.

Naming Conventions

Resource names represent the object

  • User
  • Device
  • Extension

Singular resources mean exactly one.

  • A single user: resource = user
  • A single device: resource = device
  • A single extension: resource = extension

Plural resources mean more than one.

  • A list of users: resource = users
  • A list of devices: resource = devices
  • A list of extensions: resource = extensions

Policy Behavior

When using the UDS APIs, the default policy behavior is as follows:

  • When a value appears in the field for a setting, the field is updated with the supplied value.
  • When the value for the field is left empty, the field is updated to the default setting value.
  • Any field absent from the request body leaves the setting value unchanged.

Examples

The following XML samples demonstrate the policy behavior regarding the presence or lack of fields in a XML request body.

Refer to the examples in the right-hand panel.

PUT /user/{userid}

xml
Copy<user>
   <primaryExtension>
      <callForwardAllDestination>
         <sendToVoiceMailPilotNumber>true</sendToVoiceMailPilotNumber>
         <destination>673285</destination>
      </callForwardAllDestination>
   </primaryExtension>
</user>

The XML code updates the call forward all sendToVoiceMailPilotNumber and destination fields for the user's primary extension, and leaves all other settings untouched.

xml
Copy<user>
   <primaryExtension>
      <callForwardAllDestination>
         <destination>673285</destination>
      </callForwardAllDestination>
   </primaryExtension>
</user>

This updates the destination field only, and leaves all other settings untouched.

xml
Copy<user>
   <primaryExtension>
      <callForwardAllDestination>
         <sendToVoiceMailPilotNumber />
         <destination>673285</destination>
      </callForwardAllDestination>
   </primaryExtension>
</user>

This sets the destination field, and resets the sendToVoiceMailPilotNumber field to the
system default. The default settings are typically configurable by the system administrator.

Next