Cisco Unity Connection Provisioning Interface (CUPI) API -- Search Space Member API

From DocWiki

Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


Contents


Search Space API

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. Search Space's Members provide the list of partitions and their respective search spaces so that search spaces can be queried on the basis of the partitions that it contains.


Listing the Search Spaces Members Based on Partition Object ID

The following is an example of the GET request that lists all the search space members:

GET:
https://<connectionserver>/vmrest/searchspacesmembers?query=(PartitionObjectId%20is%20partiti
onobjectid)
The following is the response from the above *GET* request and the actual response will depend
upon the information given by you:
<SearchSpacesMembers total="2">
  <SearchSpacesMember>
     <URI>/vmrest/searchspacesmembers/ef101893-8687-49f6-b658-b05e110690d5</URI>
     <ObjectId> ef101893-8687-49f6-b658-b05e110690d5</ObjectId>
     <PartitionObjectId>a7108db5-c354-4b71-a72f-2c945291bda2</PartitionObjectId>
     <PartitionURI>/vmrest/partitions/a7108db5-c354-4b71-a72f-
    2c945291bda2</PartitionURI>
     <SearchSpaceObjectId>d4885446-a1f9-4e4c-810f-168bcc8489af</SearchSpaceObjectId>
     <SearchSpaceURI>/vmrest/searchspaces/d4885446-a1f9-4e4c-810f-
   168bcc8489af</SearchSpaceURI>
     <SortOrder>1</SortOrder>
  </SearchSpacesMember>
  <SearchSpacesMember>
     <URI>/vmrest/searchspacesmembers/b3431606-ccd2-4c06-9a12-9c336c78968c</URI>
     <ObjectId>b3431606-ccd2-4c06-9a12-9c336c78968c</ObjectId>
     <PartitionObjectId>a7108db5-c354-4b71-a72f-2c945291bda2</PartitionObjectId>
     <PartitionURI>/vmrest/partitions/a7108db5-c354-4b71-a72f-
    2c945291bda2</PartitionURI>
     <SearchSpaceObjectId>9b3eb53b-445f-416e-b5f3-
    15c64428d190</SearchSpaceObjectId>
     <SearchSpaceURI>/vmrest/searchspaces/9b3eb53b-445f-416e-b5f3-
    15c64428d190</SearchSpaceURI>
     <SortOrder>1</SortOrder>
  </SearchSpacesMember>
</SearchSpacesMembers>
Response Code: 200

JSON Example

To list all the search space members use the following command, do the following:

GET:
https://<connectionserver>/vmrest/searchspacesmembers?query=(PartitionObjectId%20is%20partitiono
bjectid)
Accept: application/json
Connection: keep-alive

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

{
  "@total":"2"
  "SearchSpacesMember":[
  {
     "URI":"/vmrest/searchspacesmembers/063ac262-41a9-41a2-810a-5380ffec322d"
     "ObjectId":"063ac262-41a9-41a2-810a-5380ffec322d"
     "PartitionObjectId":"97bf6afe-346e-4275-967e-43c50be79d32"
     "PartitionURI":"/vmrest/partitions/97bf6afe-346e-4275-967e-43c50be79d32"
     "SearchSpaceObjectId":"2e836e16-f715-4a18-bb7c-ee5e33281706"
     "SearchSpaceURI":"/vmrest/searchspaces/2e836e16-f715-4a18-bb7c-ee5e33281706"
     "SortOrder":"1"
  },
  {
     "URI":"/vmrest/searchspacesmembers/62a37620-50b0-4992-8c39-242cea8c7da9"
     "ObjectId":"62a37620-50b0-4992-8c39-242cea8c7da9"
     "PartitionObjectId":"44bdcf73-d5c1-4866-957d-fb35686cbe76"
     "PartitionURI":"/vmrest/partitions/44bdcf73-d5c1-4866-957d-fb35686cbe76"
     "SearchSpaceObjectId":"97efa220-31a7-4409-a0cd-2cdfc669182f"
     "SearchSpaceURI":"/vmrest/searchspaces/97efa220-31a7-4409-a0cd-2cdfc669182f"
     "SortOrder":"1"
  }
  ]
}
Response Code: 200


Explanation of Data Fields

The following table lists all of the data fields:

Parameter Operations Data Type Comments
URI Read Only String URI of Search Space’s member
ObjectId Read Only String(36) Object Id of the search space’s member
PartitionObjectId Read Only String(36) Object Id of the partition.
PartitionURI Read Only String URI of the partition.
SearchSpaceObjectId Read Only String(36) Object Id of the search space

Rating: 0.0/5 (0 votes cast)

Personal tools