Cisco Unity Connection API List Examples

From DocWiki

(Difference between revisions)
Jump to: navigation, search
m
 
(One intermediate revision not shown)
Line 1: Line 1:
-
== Cisco Unity Connection API List Examples ==
+
{| border="1" class="wikitable"
 +
|-
 +
! style="background-color: rgb(255,215,0)" | Return to [[Unified Communications in a Virtualized Environment|Home]]
 +
|}
-
=== <font face="verdana" color=#4169E1 size=3><b>Examples for /vmrest/version</b></font> ===
+
<br> '''We have moved!'''<br>  
-
==== Example 1: GET====
+
'''The new web address for this page is&nbsp;:&nbsp; [https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/REST-API/APIs_Pages/b_CUC_Draft/b_CUC_Draft_chapter_01.html https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/REST-API/APIs_Pages/b_CUC_Draft/b_CUC_Draft_chapter_01.html]'''
-
HTTP GET:
+
'''Please update your bookmark.'''
-
<pre>https://10.10.10.10:8443/vmrest/version</pre>
+
-
 
+
-
HTTP RESPONSE:
+
-
<pre>
+
-
<VersionInformation>
+
-
    <name>vmrest</name>
+
-
    <version>8.6.2.0ES3</version>
+
-
</VersionInformation>
+
-
</pre>
+
-
 
+
-
 
+
-
=== <font face="verdana" color=#4169E1 size=3><b>Examples for /vmrest/distributionlist</b></font> ===
+
-
 
+
-
==== Example 1: GET ====
+
-
 
+
-
HTTP GET:
+
-
<pre>https://10.10.10.10:8443/vmrest/distributionlists</pre>
+
-
 
+
-
HTTP RESPONSE:
+
-
<pre>
+
-
<DistributionLists total="2">
+
-
  <DistributionList>
+
-
    <URI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</URI>
+
-
    <ObjectId>92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</ObjectId>
+
-
    <Alias>undeliverablemessages</Alias>
+
-
    <DisplayName>Undeliverable Messages</DisplayName>
+
-
    <LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
+
-
    <LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
+
-
    <PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
+
-
    <PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
+
-
    <DistributionListMembersURI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e/distributionlistmembers</DistributionListMembersURI>
+
-
    <AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2092fa35cc-a72e-4f59-83e5-ccf6fce07f1e)</AlternateNamesURI>
+
-
  </DistributionList>
+
-
  <DistributionList>
+
-
    <URI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a</URI>
+
-
    <ObjectId>24f444c9-34ce-4072-9270-672933c7bb3a</ObjectId>
+
-
    <Alias>allvoicemailusers</Alias>
+
-
    <DisplayName>All Voice Mail Users</DisplayName>
+
-
    <LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
+
-
    <LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
+
-
    <DtmfAccessId>99991</DtmfAccessId>
+
-
    <PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
+
-
    <PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
+
-
    <DistributionListMembersURI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a/distributionlistmembers</DistributionListMembersURI>
+
-
    <AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2024f444c9-34ce-4072-9270-672933c7bb3a)</AlternateNamesURI>
+
-
  </DistributionList>
+
-
</DistributionLists>
+
-
</pre>
+
-
 
+
-
==== Example 2: GET ====
+
-
 
+
-
HTTP GET:
+
-
<pre>https://10.10.10.10:8443/vmrest/distributionlists?query=(alias startswith F)&sort=(alias desc)</pre>
+
-
 
+
-
HTTP RESPONSE:
+
-
<pre>
+
-
<DistributionLists total="2">
+
-
  <DistributionList>
+
-
    <URI>/vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0</URI>
+
-
    <ObjectId>de9cb6c5-873c-454b-8fd3-58b7aaf62dd0</ObjectId>
+
-
    <Alias>FSTDK02</Alias>
+
-
    <DisplayName>FSTDK02</DisplayName>
+
-
    <LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
+
-
    <LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
+
-
    <DtmfAccessId>4445</DtmfAccessId>
+
-
    <PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
+
-
    <PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
+
-
    <DistributionListMembersURI>/vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0/distributionlistmembers</DistributionListMembersURI>
+
-
    <AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20de9cb6c5-873c-454b-8fd3-58b7aaf62dd0)</AlternateNamesURI>
+
-
  </DistributionList>
+
-
  <DistributionList>
+
-
    <URI>/vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180</URI>
+
-
    <ObjectId>d3e0c786-0be4-4b72-a27b-c745d1504180</ObjectId>
+
-
    <Alias>FSTDK01</Alias>
+
-
    <DisplayName>FSTDK01</DisplayName>
+
-
    <LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
+
-
    <LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
+
-
    <DtmfAccessId>4444</DtmfAccessId>
+
-
    <PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
+
-
    <PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
+
-
    <DistributionListMembersURI>/vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180/distributionlistmembers</DistributionListMembersURI>
+
-
    <AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20d3e0c786-0be4-4b72-a27b-c745d1504180)</AlternateNamesURI>
+
-
  </DistributionList>
+
-
</DistributionLists>
+
-
</pre>
+
-
 
+
-
==== Example 3: POST ====
+
-
 
+
-
HTTP POST:
+
-
<pre>https://10.10.10.10:8443/vmrest/distributionlists</pre>
+
-
 
+
-
HTTP BODY:
+
-
<pre>
+
-
<DistributionList>
+
-
  <Alias>FSTDK03</Alias>
+
-
  <DisplayName>FSTDK03</DisplayName>
+
-
  <DtmfAccessId>4446</DtmfAccessId>
+
-
</DistributionList>
+
-
</pre>
+
-
 
+
-
HTTP RESPONSE:
+
-
<pre>
+
-
/vmrest/distributionlists/5f038b49-5840-4974-b555-fadfaa327024
+
-
</pre>
+
-
 
+
-
==== Example 4:PUT ====
+
-
 
+
-
HTTP PUT:
+
-
<pre>https://10.10.10.10:8443/vmrest/distributionlists/{objectid}</pre>
+
-
 
+
-
HTTP BODY:
+
-
<pre>
+
-
<DistributionList>
+
-
  <DtmfAccessId>4447</DtmfAccessId>
+
-
</DistributionList>
+
-
</pre>
+
-
 
+
-
HTTP RESPONSE:
+
-
<pre>
+
-
{empty response}  Return Code = HTTP/1.1 204 No Content
+
-
</pre>
+

Latest revision as of 09:01, 2 January 2019

Return to Home


We have moved!

The new web address for this page is :  https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/REST-API/APIs_Pages/b_CUC_Draft/b_CUC_Draft_chapter_01.html

Please update your bookmark.

Rating: 0.0/5 (0 votes cast)

Personal tools