Cisco Unity Express -- Applications REST PI Service Operation
From DocWiki
Main page: Cisco Unity Express -- REST PI Service Operations
Previous page: Cisco Unity Express -- Operations and Privileges REST PI Service Operation
Next page: Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation
Search the Cisco Unity Express documentation on the DocWiki:
Contents |
Applications
Classes
Figure 8: Application
Application
| Class Name |
Application | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Class representing configuration for a CCN application. | ||
| XML Namespace |
http://application.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
appName |
String |
Length 2 -64 |
Application name |
|
appDescription |
String |
Description for the application. | |
|
appType |
ApplicationType |
Enumeration |
Application type (AA or IVR). |
|
cfgVars |
OptionalParamter |
Parameters passed must be specified in the application script. |
Configuration parameter name and value pairs for the application script. |
|
enabled |
Boolean |
Specifies if the application is enabled. | |
|
maxSessions |
Integer |
Specifies the maximum number of subscribers who can access the application simultaneously. | |
|
scriptName |
String |
Script must exist on the the system. |
Specifies the script to be used by the application. |
ApplicationType
| Class Name |
ApplicationType (Enumeration Class) |
|---|---|
| Extends From |
BaseElement |
| Description |
Enumerates supported application types. |
| XML Namespace |
http://application.model.rest.aesop.cisco.com |
| Enum Values |
AA, IVR |
OptionalParameter
| Class Name |
OptionalParameter | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Class representing script parameter name and value pair for a CCN application. | ||
| XML Namespace |
http://application.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
name |
String |
Length 2 -64 |
Parameter name |
|
type |
String |
Read Only |
Specifies the data type (Java) of the parameter. |
|
value |
String |
Value for the parameter. |
Resources
| Resource URI | Operation | Input | Return Value |
|---|---|---|---|
|
/applications To filter the query results based on application type use query parameter "appType" - |
GET (read all applications defined) |
BaseElementList Containing list of Application objects. | |
|
/applications?appType=AA /applications?appType=IVR |
POST (define a new application) |
Application | |
|
/applications/{applicationName} |
GET (read an application) |
Application | |
|
PUT (update an application) |
Application | ||
|
DELETE (delete an application) |
