Cisco Unity Connection Provisioning Interface (CUPI) API -- Partition API
Partition API
Administrator can use this API to create, update, delete, or fetch the partition. In Cisco Unity Connection, you create partitions as a way to group together objects to which callers and users can address messages or place calls while interacting with Connection. One or more partitions can be grouped together as members of a search space, and a partition can be a member of more than one search space. The following types of objects belong to a partition:
- User Templates
- Call Handler Templates
- Contact Templates
- Users with mailboxes (primary extension)
- User alternate extensions
- Contacts (including VPIM contacts)
- System distribution lists
- System call handlers
- Directory handlers
- Interview handlers
- VPIM locations
Extensions must be unique within a partition, although partitions can contain objects that do not have an associated extension (for example, some contacts and system distribution lists). The names of objects do not have to be unique within a partition. Administrator-defined contact phone numbers also do not need to be unique within a partition.
Listing the Partitions
The following is an example of the GET request that lists all the existing partitions:
|
The following is the response from the above *GET* request:
|
|
JSON Example
The following is an example of the GET command that will list all the partitions:
|
The following is the example of the response from the above *GET* request:
|
|
Viewing a Specific Partition
The following is an example of the GET request that list the detail of a particular partition:
|
The following is the response from the above *GET* request:
|
|
JSON Example
The following is an example of the GET command that will get the detail of a particular partition:
|
The following is the example of the response from the above *GET* request:
|
|
Creating a Partition
The following is an example of the POST request that creates a partition:
|
The following is the example of the response from the above *Post* request:
|
JSON Example
The following is an example of the POST command that will create a new partition:
|
The following is the example of the response from the above *GET* request:
|
Updating a Partition
The following is an example of the PUT request that allows you to update a partition:
|
|
The output for this request returns the successful response code.
JSON Example
The following is an example of the PUT command that will update a partition:
|
The following is the example of the response from the above *PUT * request:
|
Deleting a Partition
The following is an example of the DELETE request that deletes a specific partition where you need to mention the partition object ID:
Note |
You are not allowed to delete a default search space if a partition is referred in a search space, or referred by a user. |
|
The output for this request returns the successful response code.
JSON Example
The following is an example of the DELETE command that will delete a partition:
|
|
Deleting a Partition Included in Search Scope
Make sure to add the partition to a search space. The following is an example of the DELETE request that deletes a specific partition which is included in a search scope:
|
|
JSON Example
The following is an example to delete a partition included in a search scope:
|
|
Explanation of Data Fields
Parameter | Operations | Data Type | Comments |
---|---|---|---|
ObjectId | Read Only | String (36) | The primary key for this table. A systemgenerated, globally unique object identifier. |
Name | Read/Write | String (50) | The unique text name of this partition. This name is used when displaying entries in the administrative interface. The name can be upto 50 characters long. |
Description | Read/Write | String (50) | The description of the partition. If a description is not entered, the partition name is entered. |
LocationObjectId | Read Only | String (36) | The unique identifier of the LocationVms on which this partition was created. It is used by networking to determine on which LocationVms the properties of the partition are administered. |