McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 37

↗ View in doc context
page
37
source
unity-connection/rest-api/cupi/cupi.md
chunk_id
unity-connection::rest-api::cupi::cupi::4

C H A P T E R 2 Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details Links to Other API pages:Cisco_Unity_Connection_APIs • Getting the Schema Details, on page 5 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. In the case of users the schema shows what will come back when fetching the full user data using a URL like this: Note 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. Cisco Unity Connection Provisioning Interface (CUPI) API 5

Image 1 from page 37

Image 2 from page 37