Cisco Unity Connection API List

From DocWiki

(Difference between revisions)
Jump to: navigation, search
m
m
 
(4 intermediate revisions not shown)
Line 2: Line 2:
-
{| width="85%" cellpadding="5%" cellspacing="0" border="1"
+
<!-- VERSION -->
 +
 
 +
{| width="100%" cellpadding="5%" cellspacing="0" border="1"
| colspan="2" | <font face="verdana" color=#4169E1 size=3><b>/vmrest/version</b></font>
| colspan="2" | <font face="verdana" color=#4169E1 size=3><b>/vmrest/version</b></font>
|-
|-
| style="width: 25%;"| '''Description:'''
| style="width: 25%;"| '''Description:'''
-
| style="width: 60%;"| Use this API to retrieve the current version of the APIs running on the system.   
+
| style="width: 60%;"| Use this API to retrieve the current version of the system.   
|-
|-
| style="width: 25%;"| '''API URI:'''
| style="width: 25%;"| '''API URI:'''
-
| style="width: 60%;"| <nowiki>https://<host>:<port>/vmrest/version</nowiki>
+
| style="width: 60%;"| <pre><nowiki>https://<host>:<port>/vmrest/version</nowiki></pre>
|-
|-
| style="width: 25%;"| '''Supported Response Formats:'''
| style="width: 25%;"| '''Supported Response Formats:'''
Line 26: Line 28:
| style="width: 60%;"| None.
| style="width: 60%;"| None.
|-
|-
-
| style="width: 25%;"| '''Successful Response Schema:'''
+
| style="width: 25%;"| '''Schema:'''
-
| style="width: 60%;"|  
+
| style="width: 60%;"| <pre><nowiki>https://10.10.10.10:8443/vmrest/schema/VersionInformation</nowiki></pre>
-
<pre>
+
|-
-
<xs:schema elementFormDefault="qualified">
+
| style="width: 25%;"| '''Failure Response Schema:'''
-
    <xs:complexType name="VersionInformation">
+
| style="width: 60%;"| None.
-
        <xs:sequence>
+
|-
-
          <xs:element name="name" type="xs:string"/>
+
| style="width: 25%;"| '''Related Error Codes:'''
-
          <xs:element name="version" type="xs:string"/>
+
| style="width: 60%;"| See API Response Codes.
-
        </xs:sequence>
+
|-
-
    </xs:complexType>
+
| style="width: 25%;"| '''Events Triggered:'''
-
    <xs:element name="VersionInformation" type="VersionInformation"/>
+
| style="width: 60%;"| None.
-
</xs:schema>
+
|-
-
</pre>
+
| style="width: 25%;"| '''Release:'''
 +
| style="width: 60%;"| 8.5(1)
 +
|-
 +
| style="width: 25%;"| '''Notes or Examples:'''
 +
| style="width: 60%;"| [[Cisco_Unity_Connection_API_List_Examples|Example]]
 +
|}
 +
 
 +
<!-- DISTRIBUTION LISTS -->
 +
 
 +
{| width="100%" cellpadding="5%" cellspacing="0" border="1"
 +
| colspan="2" | <font face="verdana" color=#4169E1 size=3><b>/vmrest/distributionlists</b></font>
 +
|-
 +
| style="width: 25%;"| '''Description:'''
 +
| style="width: 60%;"| Use this API to work with distribution lists.
 +
|-
 +
| style="width: 25%;"| '''API URI:'''
 +
| style="width: 60%;"| <pre><nowiki>https://<host>:<port>/vmrest/distributionlists</nowiki></pre>
 +
|-
 +
| style="width: 25%;"| '''Supported Response Formats:'''
 +
| style="width: 60%;"| XML
 +
|-
 +
| style="width: 25%;"| '''HTTP Method:'''
 +
| style="width: 60%;"| GET,POST,PUT,DELETE
 +
|-
 +
| style="width: 25%;"| '''Request Parameters:'''
 +
| style="width: 60%;"| query, sort, pageNumber, rowsPerPage, properties
 +
|-
 +
| style="width: 25%;"| '''Header Parameters:'''
 +
| style="width: 60%;"| None.
 +
|-
 +
| style="width: 25%;"| '''Parameter Description:'''
 +
| style="width: 60%;"| None.
 +
|-
 +
| style="width: 25%;"| '''Schema:'''
 +
| style="width: 60%;"| <pre><nowiki>https://10.10.10.10:8443/vmrest/schema/DistributionList</nowiki></pre>
 +
|-
 +
| style="width: 25%;"| '''Failure Response Schema:'''
 +
| style="width: 60%;"| None.
 +
|-
 +
| style="width: 25%;"| '''Related Error Codes:'''
 +
| style="width: 60%;"| See API Response Codes.
 +
|-
 +
| style="width: 25%;"| '''Events Triggered:'''
 +
| style="width: 60%;"| None.
 +
|-
 +
| style="width: 25%;"| '''Release:'''
 +
| style="width: 60%;"| 8.5(1)
 +
|-
 +
| style="width: 25%;"| '''Notes or Examples:'''
 +
| style="width: 60%;"| [[Cisco_Unity_Connection_API_List_Examples|Example]]
 +
|}
 +
 
 +
<!-- DISTRIBUTION LISTS OBJECT ID DISTRIBUTION LIST MEMBERS -->
 +
 
 +
{| width="100%" cellpadding="5%" cellspacing="0" border="1"
 +
| colspan="2" | <font face="verdana" color=#4169E1 size=3><b>/vmrest/distributionlists/{objectid}/distributionlistmembers</b></font>
 +
|-
 +
| style="width: 25%;"| '''Description:'''
 +
| style="width: 60%;"| Use this API to work with distribution lists.
 +
|-
 +
| style="width: 25%;"| '''API URI:'''
 +
| style="width: 60%;"| <pre><nowiki>https://<host>:<port>/vmrest/distributionlists/{objectid}/distributionlistmembers</nowiki></pre>
 +
|-
 +
| style="width: 25%;"| '''Supported Response Formats:'''
 +
| style="width: 60%;"| XML
 +
|-
 +
| style="width: 25%;"| '''HTTP Method:'''
 +
| style="width: 60%;"| GET,POST,PUT,DELETE
 +
|-
 +
| style="width: 25%;"| '''Request Parameters:'''
 +
| style="width: 60%;"| query, sort, pageNumber, rowsPerPage, properties
 +
|-
 +
| style="width: 25%;"| '''Header Parameters:'''
 +
| style="width: 60%;"| None.
 +
|-
 +
| style="width: 25%;"| '''Parameter Description:'''
 +
| style="width: 60%;"| None.
 +
|-
 +
| style="width: 25%;"| '''Schema:'''
 +
| style="width: 60%;"| <pre><nowiki>https://10.10.10.10:8443/vmrest/schema/DistributionListMember</nowiki></pre>
|-
|-
| style="width: 25%;"| '''Failure Response Schema:'''
| style="width: 25%;"| '''Failure Response Schema:'''

Latest revision as of 22:53, 21 February 2012

DRAFT


/vmrest/version
Description: Use this API to retrieve the current version of the system.
API URI: 
https://<host>:<port>/vmrest/version
Supported Response Formats: XML
HTTP Method: GET
Request Parameters: None.
Header Parameters: None.
Parameter Description: None.
Schema: 
https://10.10.10.10:8443/vmrest/schema/VersionInformation
Failure Response Schema: None.
Related Error Codes: See API Response Codes.
Events Triggered: None.
Release: 8.5(1)
Notes or Examples: Example


/vmrest/distributionlists
Description: Use this API to work with distribution lists.
API URI: 
https://<host>:<port>/vmrest/distributionlists
Supported Response Formats: XML
HTTP Method: GET,POST,PUT,DELETE
Request Parameters: query, sort, pageNumber, rowsPerPage, properties
Header Parameters: None.
Parameter Description: None.
Schema: 
https://10.10.10.10:8443/vmrest/schema/DistributionList
Failure Response Schema: None.
Related Error Codes: See API Response Codes.
Events Triggered: None.
Release: 8.5(1)
Notes or Examples: Example


/vmrest/distributionlists/{objectid}/distributionlistmembers
Description: Use this API to work with distribution lists.
API URI: 
https://<host>:<port>/vmrest/distributionlists/{objectid}/distributionlistmembers
Supported Response Formats: XML
HTTP Method: GET,POST,PUT,DELETE
Request Parameters: query, sort, pageNumber, rowsPerPage, properties
Header Parameters: None.
Parameter Description: None.
Schema: 
https://10.10.10.10:8443/vmrest/schema/DistributionListMember
Failure Response Schema: None.
Related Error Codes: See API Response Codes.
Events Triggered: None.
Release: 8.5(1)
Notes or Examples: Example

Rating: 0.0/5 (0 votes cast)

Retrieved from "http://docwiki.cisco.com/wiki/Cisco_Unity_Connection_API_List"
Personal tools