[Index]
Model ref.: device/cuc/UserTemplateNotificationDevice
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,
"title": "Success Retry Interval",
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is successful.",
"name": "SuccessRetryInterval"
},
"DisplayName": {
"minItems": 0,
"title": "Display Name",
"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"
},
"AfterDialDigits": {
"minItems": 0,
"title": "After Dial Digits",
"type": "string",
"description": " The extra digits (if any) that Cisco Unity Connection will dial after the phone number.",
"name": "AfterDialDigits"
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"InitialDelay": {
"title": "Initial Delay",
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"title": "Phone System URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RetriesOnSuccess": {
"minItems": 0,
"title": "Retries On Success",
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if it is successful.",
"name": "RetriesOnSuccess"
},
"SendCount": {
"minItems": 0,
"title": "Send Count",
"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"
},
"Type": {
"minItems": 0,
"title": "Type",
"type": "integer",
"description": " The device type (Dial, Numeric Pager, SMTP, Fax, HTML).",
"name": "Type"
},
"DeviceName": {
"minItems": 0,
"title": "Device Name",
"type": "string",
"description": " The \"DeviceName\" of the notification device.",
"name": "DeviceName"
},
"UrgentOnly": {
"title": "Urgent Only",
"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": "UrgentOnly"
},
"MaxSubject": {
"minItems": 0,
"title": "Max Subject",
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject"
},
"SubscriberObjectId": {
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"name": "SubscriberObjectId",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/UserTemplate",
"title": "Subscriber Object Id",
"type": [
"string"
],
"target": "/api/device/cuc/UserTemplate/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ScheduleSetObjectId": {
"title": "Schedule Set Object Id",
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId"
},
"HeaderText": {
"minItems": 0,
"title": "Header Text",
"type": "string",
"description": " The actual header text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the \"Header Text:\" field.",
"name": "HeaderText"
},
"FooterText": {
"minItems": 0,
"title": "Footer Text",
"type": "string",
"description": " The actual footer text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the \"Footer Text:\" field.",
"name": "FooterText"
},
"Active": {
"minItems": 0,
"title": "Active",
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active"
},
"MediaSwitchDisplayName": {
"minItems": 0,
"title": "Media Switch Display Name",
"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"
},
"RnaRetryInterval": {
"minItems": 0,
"title": "Rna Retry Interval",
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.",
"name": "RnaRetryInterval"
},
"RetriesOnBusy": {
"minItems": 0,
"title": "Retries On Busy",
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if it is busy.",
"name": "RetriesOnBusy"
},
"SmtpAddress": {
"minItems": 0,
"title": "Smtp Address",
"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"
},
"RepeatInterval": {
"title": "Repeat Interval",
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval"
},
"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,
"title": "Max Body",
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody"
},
"EventList": {
"title": "Event List",
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList"
},
"DetectTransferLoop": {
"minItems": 0,
"title": "Detect Transfer Loop",
"type": "boolean",
"description": " A flag indicating whether Unity can do a loop detect transfer to this device.",
"name": "DetectTransferLoop"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DialDelay": {
"minItems": 0,
"title": "Dial Delay",
"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"
},
"StaticText": {
"minItems": 0,
"title": "Static Text",
"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"
},
"Conversation": {
"minItems": 0,
"title": "Conversation",
"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"
},
"PromptForId": {
"minItems": 0,
"title": "Prompt For Id",
"type": "boolean",
"description": " A flag indicating whether to prompt a subscriber for their Cisco Unity Connection ID, or just their password.",
"name": "PromptForId"
},
"PhoneNumber": {
"minItems": 0,
"title": "Phone Number",
"type": "string",
"description": " The phone number to dial, including the trunk access code (if any), of the device.",
"name": "PhoneNumber"
},
"Undeletable": {
"minItems": 0,
"title": "Undeletable",
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable"
},
"SendCallerId": {
"minItems": 0,
"title": "Send Caller Id",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ",
"name": "SendCallerId"
},
"RingsToWait": {
"minItems": 0,
"title": "Rings To Wait",
"type": "integer",
"description": " The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.",
"name": "RingsToWait"
},
"VoiceMessage": {
"title": "Voice Message",
"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": "VoiceMessage"
},
"SendPcaLink": {
"minItems": 0,
"title": "Send Pca Link",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include a link to the PCA with the notification message. ",
"name": "SendPcaLink"
},
"FailDeviceObjectId": {
"title": "Fail Device Object Id",
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId"
},
"WaitConnect": {
"minItems": 0,
"title": "Wait Connect",
"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"
},
"BusyRetryInterval": {
"minItems": 0,
"title": "Busy Retry Interval",
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.",
"name": "BusyRetryInterval"
},
"RetriesOnRna": {
"minItems": 0,
"title": "Retries On Rna",
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if the device does not answer.",
"name": "RetriesOnRna"
},
"RepeatNotify": {
"title": "Repeat Notify",
"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"
},
"SmppProviderObjectId": {
"minItems": 0,
"title": "Smpp Provider Object Id",
"type": "string",
"description": " The unique identifier of the SMPPProvider object that is used by this notification device.",
"name": "SmppProviderObjectId"
},
"MediaSwitchObjectId": {
"minItems": 0,
"title": "Media Switch Object Id",
"type": "string",
"description": " The unique identifier of the MediaSwitch object to use for notification. ",
"name": "MediaSwitchObjectId"
},
"TransmitForcedAuthorizationCode": {
"minItems": 0,
"title": "Transmit Forced Authorization Code",
"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"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/UserTemplateNotificationDevice/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/UserTemplateNotificationDevice/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/UserTemplateNotificationDevice/[pkid1]", "/api/v0/device/cuc/UserTemplateNotificationDevice/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/UserTemplateNotificationDevice/?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/UserTemplateNotificationDevice |
|
{"hrefs": ["/api/device/cuc/UserTemplateNotificationDevice/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/UserTemplateNotificationDevice |
|
{"hrefs": ["/api/device/cuc/UserTemplateNotificationDevice/[pkid1]", "/api/device/cuc/UserTemplateNotificationDevice/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/UserTemplateNotificationDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/UserTemplateNotificationDevice/export/ |
|
{ "hrefs":["/api/device/cuc/UserTemplateNotificationDevice/[pkid1]", "/api/device/cuc/UserTemplateNotificationDevice/[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/UserTemplateNotificationDevice and the JSON format can be used to import instances of device/cuc/UserTemplateNotificationDevice.
GET http://[host-proxy]/api/device/cuc/UserTemplateNotificationDevice/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/UserTemplateNotificationDevice | POST | /api/device/cuc/UserTemplateNotificationDevice/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/UserTemplateNotificationDevice/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/UserTemplateNotificationDevice/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/UserTemplateNotificationDevice/ |
|
The device/cuc/UserTemplateNotificationDevice schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/UserTemplateNotificationDevice instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/UserTemplateNotificationDevice/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 48
},
"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/UserTemplateNotificationDevice/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/UserTemplateNotificationDevice",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplateNotificationDevice/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/UserTemplateNotificationDevice/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/UserTemplateNotificationDevice/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/UserTemplateNotificationDevice/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/UserTemplateNotificationDevice/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/UserTemplateNotificationDevice/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/UserTemplateNotificationDevice/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplateNotificationDevice",
"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"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "61b132aaeadb826afd7c9524",
"meta": {
"tags": [],
"cached": true,
"title": "Home Phone",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f13eadb826afd7b7dd9",
"href": "/api/v0/data/UnityConnection/61b12f13eadb826afd7b7dd9"
}
],
"self": [
{
"pkid": "61b132aaeadb826afd7c9524",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/"
}
],
"parent": [
{
"pkid": "61b12e93eadb826afd7b5dad",
"href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b132aaeadb826afd7c9524/?model_type=device/cuc/UserTemplateNotificationDevice",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplateNotificationDevice",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b132aaeadb826afd7c9524"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"SuccessRetryInterval": 0,
"DisplayName": "Home Phone",
"hierarchy": "61b12e93eadb826afd7b5dad",
"UserURI": "/vmrest/users/cdfadb1e-4b22-486c-ac60-5543558de813",
"InitialDelay": 0,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"RetriesOnSuccess": 0,
"SendCount": false,
"hierarchy_friendly_name": "CS-P (Provider)",
"Type": 1,
"hierarchy_path": "sys.hcs.CS-P",
"DeviceName": "Home Phone",
"MaxSubject": 64,
"SubscriberObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838",
"Active": false,
"MediaSwitchDisplayName": "PhoneSystem",
"summary_device": "Partitioned CUCxn, 192.168.100.22, 8443, hcs.CS-P",
"RnaRetryInterval": 15,
"RetriesOnBusy": 4,
"RepeatInterval": 0,
"ObjectId": "34704ea0-f3d5-4c96-bffd-7f09f620b252",
"MaxBody": 512,
"EventList": "NewVoiceMail",
"DetectTransferLoop": false,
"URI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatenotificationdevices/34704ea0-f3d5-4c96-bffd-7f09f620b252",
"DialDelay": 1,
"Conversation": "SubNotify",
"PromptForId": false,
"Undeletable": true,
"SendCallerId": false,
"RingsToWait": 4,
"SendPcaLink": false,
"WaitConnect": true,
"BusyRetryInterval": 5,
"RetriesOnRna": 4,
"RepeatNotify": false,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"TransmitForcedAuthorizationCode": false
}
},
{
"pkid": "61b1333eeadb826afd7cb1f6",
"meta": {
"tags": [],
"cached": true,
"title": "Home Phone",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f56eadb826afd7b8db9",
"href": "/api/v0/data/UnityConnection/61b12f56eadb826afd7b8db9"
}
],
"self": [
{
"pkid": "61b1333eeadb826afd7cb1f6",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b1333eeadb826afd7cb1f6/"
}
],
"parent": [
{
"pkid": "61b12edfeadb826afd7b715a",
"href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b1333eeadb826afd7cb1f6/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b1333eeadb826afd7cb1f6/?model_type=device/cuc/UserTemplateNotificationDevice",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b1333eeadb826afd7cb1f6/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b1333eeadb826afd7cb1f6/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b1333eeadb826afd7cb1f6/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b1333eeadb826afd7cb1f6/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/UserTemplateNotificationDevice",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b12edfeadb826afd7b715a",
"61b1333eeadb826afd7cb1f6"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"SuccessRetryInterval": 0,
"DisplayName": "Home Phone",
"hierarchy": "61b12edfeadb826afd7b715a",
"UserURI": "/vmrest/users/1aaf3b51-afa9-4d7e-9ee5-299635cc26df",
"InitialDelay": 0,
"PhoneSystemURI": "/vmrest/phonesystems/8932164b-bfcd-4ba7-9aed-33e8c4548046",
"RetriesOnSuccess": 0,
"SendCount": false,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"Type": 1,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"DeviceName": "Home Phone",
"MaxSubject": 64,
"SubscriberObjectId": "1aaf3b51-afa9-4d7e-9ee5-299635cc26df",
"ScheduleSetObjectId": "1729b420-bf89-47e2-a44a-ff5e81761566",
"Active": false,
"MediaSwitchDisplayName": "PhoneSystem",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"RnaRetryInterval": 15,
"RetriesOnBusy": 4,
"RepeatInterval": 0,
"ObjectId": "8ab1a12b-6d7e-4a71-85fd-73a039e0f0be",
"MaxBody": 512,
"EventList": "NewVoiceMail",
"DetectTransferLoop": false,
"URI": "/vmrest/usertemplates/1aaf3b51-afa9-4d7e-9ee5-299635cc26df/usertemplatenotificationdevices/8ab1a12b-6d7e-4a71-85fd-73a039e0f0be",
"DialDelay": 1,
"Conversation": "SubNotify",
"PromptForId": false,
"Undeletable": true,
"SendCallerId": false,
"RingsToWait": 4,
"SendPcaLink": false,
"WaitConnect": true,
"BusyRetryInterval": 5,
"RetriesOnRna": 4,
"RepeatNotify": false,
"MediaSwitchObjectId": "8932164b-bfcd-4ba7-9aed-33e8c4548046",
"TransmitForcedAuthorizationCode": false
}
},
{
"pkid": "61b13523eadb826afd7d1b91",
"meta": {
"tags": [],
"cached": true,
"title": "Home Phone",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12fa5eadb826afd7ba3e2",
"href": "/api/v0/data/UnityConnection/61b12fa5eadb826afd7ba3e2"
}
],
"self": [
{
"pkid": "61b13523eadb826afd7d1b91",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b13523eadb826afd7d1b91/"
}
],
"parent": [
{
"pkid": "61b12edfeadb826afd7b715a",
"href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b13523eadb826afd7d1b91/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/61b13523eadb826afd7d1b91/?model_type=device/cuc/UserTemplateNotificationDevice",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b13523eadb826afd7d1b91/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b13523eadb826afd7d1b91/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b13523eadb826afd7d1b91/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b13523eadb826afd7d1b91/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplateNotificationDevice",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b12edfeadb826afd7b715a",
"61b13523eadb826afd7d1b91"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"SuccessRetryInterval": 0,
"DisplayName": "Home Phone",
"hierarchy": "61b12edfeadb826afd7b715a",
"UserURI": "/vmrest/users/1aaf3b51-afa9-4d7e-9ee5-299635cc26df",
"InitialDelay": 0,
"PhoneSystemURI": "/vmrest/phonesystems/8932164b-bfcd-4ba7-9aed-33e8c4548046",
"RetriesOnSuccess": 0,
"SendCount": false,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"Type": 1,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"DeviceName": "Home Phone",
"MaxSubject": 64,
"SubscriberObjectId": "1aaf3b51-afa9-4d7e-9ee5-299635cc26df",
"ScheduleSetObjectId": "1729b420-bf89-47e2-a44a-ff5e81761566",
"Active": false,
"MediaSwitchDisplayName": "PhoneSystem",
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"RnaRetryInterval": 15,
"RetriesOnBusy": 4,
"RepeatInterval": 0,
"ObjectId": "8ab1a12b-6d7e-4a71-85fd-73a039e0f0be",
"MaxBody": 512,
"EventList": "NewVoiceMail",
"DetectTransferLoop": false,
"URI": "/vmrest/usertemplates/1aaf3b51-afa9-4d7e-9ee5-299635cc26df/usertemplatenotificationdevices/8ab1a12b-6d7e-4a71-85fd-73a039e0f0be",
"DialDelay": 1,
"Conversation": "SubNotify",
"PromptForId": false,
"Undeletable": true,
"SendCallerId": false,
"RingsToWait": 4,
"SendPcaLink": false,
"WaitConnect": true,
"BusyRetryInterval": 5,
"RetriesOnRna": 4,
"RepeatNotify": false,
"MediaSwitchObjectId": "8932164b-bfcd-4ba7-9aed-33e8c4548046",
"TransmitForcedAuthorizationCode": false
}
}
]
}
(Show the first instance)
{
"pkid": "61b132aaeadb826afd7c9524",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Home Phone",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "61b12e93eadb826afd7b5dad",
"href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad"
}
],
"self": [
{
"pkid": "61b132aaeadb826afd7c9524",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f13eadb826afd7b7dd9",
"href": "/api/v0/data/UnityConnection/61b12f13eadb826afd7b7dd9"
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b132aaeadb826afd7c9524/?hierarchy=[hierarchy]&model_type=device/cuc/UserTemplateNotificationDevice",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/UserTemplateNotificationDevice/61b132aaeadb826afd7c9524/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplateNotificationDevice",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b132aaeadb826afd7c9524"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"SuccessRetryInterval": 0,
"DisplayName": "Home Phone",
"UserURI": "/vmrest/users/cdfadb1e-4b22-486c-ac60-5543558de813",
"BusyRetryInterval": 5,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"RetriesOnSuccess": 0,
"SendCount": false,
"MaxSubject": 64,
"DeviceName": "Home Phone",
"Type": 1,
"SubscriberObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838",
"Active": false,
"MediaSwitchDisplayName": "PhoneSystem",
"RnaRetryInterval": 15,
"RetriesOnBusy": 4,
"RepeatInterval": 0,
"ObjectId": "34704ea0-f3d5-4c96-bffd-7f09f620b252",
"MaxBody": 512,
"EventList": "NewVoiceMail",
"DetectTransferLoop": false,
"URI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatenotificationdevices/34704ea0-f3d5-4c96-bffd-7f09f620b252",
"DialDelay": 1,
"Conversation": "SubNotify",
"PromptForId": false,
"Undeletable": true,
"SendCallerId": false,
"RingsToWait": 4,
"SendPcaLink": false,
"WaitConnect": true,
"InitialDelay": 0,
"RetriesOnRna": 4,
"RepeatNotify": false,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"TransmitForcedAuthorizationCode": false
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/UserTemplateNotificationDevice. | GET | /api/device/cuc/UserTemplateNotificationDevice/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/UserTemplateNotificationDevice as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/UserTemplateNotificationDevice/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/UserTemplateNotificationDevice/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/UserTemplateNotificationDevice | 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/UserTemplateNotificationDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/UserTemplateNotificationDevice/[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/UserTemplateNotificationDevice and the JSON format can be used to import instances of device/cuc/UserTemplateNotificationDevice.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/UserTemplateNotificationDevice/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/UserTemplateNotificationDevice instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/UserTemplateNotificationDevice/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/UserTemplateNotificationDevice. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/UserTemplateNotificationDevice/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |