[Index]
Model ref.: device/cuc/NotificationDevice
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "SuccessRetryInterval": { "minItems": 0, "type": "integer", "description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is successful.", "name": "SuccessRetryInterval", "title": "Success Retry Interval" }, "DisplayName": { "minItems": 0, "type": "string", "description": " The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Home Phone,\" Pager 2,\" \"Work Phone, \" etc. ", "name": "DisplayName", "title": "Display Name" }, "AfterDialDigits": { "minItems": 0, "type": "string", "description": " The extra digits (if any) that Cisco Unity Connection will dial after the phone number.", "name": "AfterDialDigits", "title": "After Dial Digits" }, "UserURI": { "name": "UserURI", "format": "uri", "minItems": 0, "title": "User URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "BusyRetryInterval": { "minItems": 0, "type": "integer", "description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.", "name": "BusyRetryInterval", "title": "Busy Retry Interval" }, "PhoneSystemURI": { "name": "PhoneSystemURI", "format": "uri", "minItems": 0, "title": "Phone System URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "RetriesOnSuccess": { "minItems": 0, "type": "integer", "description": " The number of times Cisco Unity Connection will retry the notification device if it is successful.", "name": "RetriesOnSuccess", "title": "Retries On Success" }, "SendCount": { "minItems": 0, "type": "boolean", "description": " A flag indicting whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message. ", "name": "SendCount", "title": "Send Count" }, "MaxSubject": { "minItems": 0, "type": "integer", "description": " The maximum number of characters allowed in the 'subject' of a notification message.", "name": "MaxSubject", "title": "Max Subject" }, "DeviceName": { "minItems": 0, "type": "string", "description": " The \"DeviceName\" of the notification device.", "name": "DeviceName", "title": "Device Name" }, "UrgentOnly": { "type": "boolean", "description": "A flag indicating whether Cisco Unity Connection sends voice message transcripted in urgent mode or not", "name": "UrgentOnly", "title": "Urgent Only" }, "Type": { "minItems": 0, "type": "integer", "description": " The device type (Dial, Numeric Pager, SMTP, Fax, HTML).", "name": "Type", "title": "Type" }, "SubscriberObjectId": { "description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]", "format": "uri", "minItems": 0, "title": "Subscriber Object Id", "required": true, "choices": [], "target_attr": "ObjectId", "target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/User", "type": [ "string" ], "name": "SubscriberObjectId" }, "ScheduleSetObjectId": { "type": "string", "description": "ObjectId of the ScheduleSet for when the notification rule is active.", "name": "ScheduleSetObjectId", "title": "Schedule Set Object Id" }, "Active": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the device is active or inactive (enabled/disabled).", "name": "Active", "title": "Active" }, "MediaSwitchDisplayName": { "minItems": 0, "type": "string", "description": "The text name of the Media Switch. The unique text name (e.g., \"Unified Communications Manager Cluster - Seattle\") of the media switch to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.", "name": "MediaSwitchDisplayName", "title": "Media Switch Display Name" }, "RnaRetryInterval": { "minItems": 0, "type": "integer", "description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.", "name": "RnaRetryInterval", "title": "Rna Retry Interval" }, "RetriesOnBusy": { "minItems": 0, "type": "integer", "description": " The number of times Cisco Unity Connection will retry the notification device if it is busy.", "name": "RetriesOnBusy", "title": "Retries On Busy" }, "SmtpAddress": { "minItems": 0, "type": "string", "description": " The e-mail address of the text pager, text-compatible cell phone, or another e-mail account (such as a home e-mail address) to which the notification message is to be sent. In the SA, this is referred to as the \"To:\" field.", "name": "SmtpAddress", "title": "Smtp Address" }, "RepeatInterval": { "type": "integer", "description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.", "name": "RepeatInterval", "title": "Repeat Interval" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDevice object. - template parameter [2]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "MaxBody": { "minItems": 0, "type": "integer", "description": " The maximum number of characters allowed in the 'body' of a notification message.", "name": "MaxBody", "title": "Max Body" }, "EventList": { "type": "string", "description": "Comma separated list of events that trigger notification rules to be evaluated.", "name": "EventList", "title": "Event List" }, "DetectTransferLoop": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Unity can do a loop detect transfer to this device.", "name": "DetectTransferLoop", "title": "Detect Transfer Loop" }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "DialDelay": { "minItems": 0, "type": "integer", "description": " The amount of time (in seconds) Cisco Unity Connection will wait after detecting a successful call before dialing specified additional digits (if any). Additional digits are contained in AfterDialDigits.\n", "name": "DialDelay", "title": "Dial Delay" }, "StaticText": { "minItems": 0, "type": "string", "description": " The actual text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the \"Send:\" field.\n", "name": "StaticText", "title": "Static Text" }, "Conversation": { "minItems": 0, "type": "string", "description": " The name of the Conversation Cisco Unity Connection will use when calling the subscriber to notify of new messages. This maps to one of the conversations in tbl_Conversation.", "name": "Conversation", "title": "Conversation" }, "PromptForId": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether to prompt a subscriber for their Cisco Unity Connection ID, or just their password.", "name": "PromptForId", "title": "Prompt For Id" }, "PhoneNumber": { "minItems": 0, "type": "string", "description": " The phone number to dial, including the trunk access code (if any), of the device.", "name": "PhoneNumber", "title": "Phone Number" }, "Undeletable": { "minItems": 0, "type": "boolean", "description": "Device cannot be deleted.", "name": "Undeletable", "title": "Undeletable" }, "SendCallerId": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ", "name": "SendCallerId", "title": "Send Caller Id" }, "RingsToWait": { "minItems": 0, "type": "integer", "description": " The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.", "name": "RingsToWait", "title": "Rings To Wait" }, "VoiceMessage": { "type": "boolean", "description": "A flag indicating whether Cisco Unity Connection sends transcription of voice message", "name": "VoiceMessage", "title": "Voice Message" }, "SendPcaLink": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection will include a link to the PCA with the notification message. ", "name": "SendPcaLink", "title": "Send Pca Link" }, "FailDeviceObjectId": { "type": "string", "description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.", "name": "FailDeviceObjectId", "title": "Fail Device Object Id" }, "WaitConnect": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection waits until it detects a connection before dialing the digits in AfterDialDigits. \n", "name": "WaitConnect", "title": "Wait Connect" }, "InitialDelay": { "type": "integer", "description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.", "name": "InitialDelay", "title": "Initial Delay" }, "RetriesOnRna": { "minItems": 0, "type": "integer", "description": " The number of times Cisco Unity Connection will retry the notification device if the device does not answer.", "name": "RetriesOnRna", "title": "Retries On Rna" }, "RepeatNotify": { "type": "boolean", "description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.", "name": "RepeatNotify", "title": "Repeat Notify" }, "SmppProviderObjectId": { "minItems": 0, "type": "string", "description": " The unique identifier of the SMPPProvider object that is used by this notification device.", "name": "SmppProviderObjectId", "title": "Smpp Provider Object Id" }, "MediaSwitchObjectId": { "minItems": 0, "type": "string", "description": " The unique identifier of the MediaSwitch object to use for notification. ", "name": "MediaSwitchObjectId", "title": "Media Switch Object Id" }, "TransmitForcedAuthorizationCode": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether an authorization code should be transmitted to Cisco Call Manager after this number is dialed during an outbound call.", "name": "TransmitForcedAuthorizationCode", "title": "Transmit Forced Authorization Code" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/NotificationDevice/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/NotificationDevice/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/NotificationDevice/[pkid1]", "/api/v0/device/cuc/NotificationDevice/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/NotificationDevice/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/NotificationDevice |
|
{"hrefs": ["/api/device/cuc/NotificationDevice/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/NotificationDevice |
|
{"hrefs": ["/api/device/cuc/NotificationDevice/[pkid1]", "/api/device/cuc/NotificationDevice/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/NotificationDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/NotificationDevice/export/ |
|
{ "hrefs":["/api/device/cuc/NotificationDevice/[pkid1]", "/api/device/cuc/NotificationDevice/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/cuc/NotificationDevice and the JSON format can be used to import instances of device/cuc/NotificationDevice.
GET http://[host-proxy]/api/device/cuc/NotificationDevice/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/NotificationDevice | POST | /api/device/cuc/NotificationDevice/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/cuc/NotificationDevice/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/cuc/NotificationDevice/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/NotificationDevice/ |
|
The device/cuc/NotificationDevice schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/NotificationDevice instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/NotificationDevice/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "14.0", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/NotificationDevice/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/NotificationDevice", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/NotificationDevice/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/cuc/NotificationDevice/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/NotificationDevice/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/NotificationDevice/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/NotificationDevice/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/NotificationDevice/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/NotificationDevice/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/NotificationDevice", "model_specific_actions": [ "list", "get", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/NotificationDevice. | GET | /api/device/cuc/NotificationDevice/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/NotificationDevice as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/NotificationDevice/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/NotificationDevice/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/NotificationDevice | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/NotificationDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/NotificationDevice/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/cuc/NotificationDevice and the JSON format can be used to import instances of device/cuc/NotificationDevice.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/NotificationDevice/[pkid] | hierarchy=[hierarchy] | The device/cuc/NotificationDevice instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/NotificationDevice/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/NotificationDevice. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/NotificationDevice/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |