Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details

From DocWiki

(Difference between revisions)
Jump to: navigation, search
 
(4 intermediate revisions not shown)
Line 1: Line 1:
 +
'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
 +
{| align="right" border="1"
 +
|align="center"|'''CUPI Guide Contents'''
 +
|-
 +
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
 +
|}
 +
 +
__TOC__
 +
 +
== Getting the Schema Details ==
 +
 +
All the schema details for all supported object types can be obtained by going to the REST schema page using the URL:
All the schema details for all supported object types can be obtained by going to the REST schema page using the URL:
-
http://{server_name}/vmrest/schema
+
<pre>
 +
<nowiki>http://{server name}/vmrest/schema</nowiki>
 +
</pre>
All the objects supported will come up in a list, each as a link that will take you to a page detailing which items of information will be returned when fetching that object.
All the objects supported will come up in a list, each as a link that will take you to a page detailing which items of information will be returned when fetching that object.
Line 7: Line 21:
NOTE: In the case of users the schema shows what will come back when fetching the full user data using a URL like this:
NOTE: In the case of users the schema shows what will come back when fetching the full user data using a URL like this:
-
http://{server_name}/vmrest/users/{object_id}
+
<pre>
 +
<nowiki>http://{server name}/vmrest/users/{object_id}</nowiki>
 +
</pre>
 +
 
If, however, you are getting a list of users or searching for one or more users with a query parameter like this:
If, however, you are getting a list of users or searching for one or more users with a query parameter like this:
-
http://{server_name}/vmrest/users?query=(alias%20is%20operator)
+
<pre>
 +
<nowiki>http://{server name}/vmrest/users?query=(alias%20is%20operator)</nowiki>
 +
</pre>
 +
 
 +
Then you will get a subset of user properties on each user returned in the list.  This is an optimization since users have such a large amount of data associated with them that returning all of those properties for each user on a potentially large list is very inefficient.  Make sure your application accounts for this.
 +
 
-
then you will get a subset of user properties on each user returned in the list.  This is an optimization since users have such a large amount of data associated with them that returning all of those properties for each user on a potentially large list is very inefficient.  Make sure your application accounts for this.
+
[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Latest revision as of 23:18, 27 August 2011

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


Getting the Schema Details

All the schema details for all supported object types can be obtained by going to the REST schema page using the URL:

http://{server name}/vmrest/schema

All the objects supported will come up in a list, each as a link that will take you to a page detailing which items of information will be returned when fetching that object.

NOTE: In the case of users the schema shows what will come back when fetching the full user data using a URL like this:

http://{server name}/vmrest/users/{object_id}


If, however, you are getting a list of users or searching for one or more users with a query parameter like this:

http://{server name}/vmrest/users?query=(alias%20is%20operator)

Then you will get a subset of user properties on each user returned in the list. This is an optimization since users have such a large amount of data associated with them that returning all of those properties for each user on a potentially large list is very inefficient. Make sure your application accounts for this.

Rating: 5.0/5 (1 vote cast)

Personal tools