[Index]
Model ref.: device/cuc/UserTemplateHtmlDevice
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": {
"DisableMobileNumberFromPCA": {
"minItems": 0,
"title": "Disable Mobile Number From PCA",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will not allow PCA to change Mobile Number.",
"name": "DisableMobileNumberFromPCA"
},
"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"
},
"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"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceHTML object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"DisableTemplateSelectionFromPCA": {
"minItems": 0,
"title": "Disable Template Selection From PCA",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will not allow PCA to select notification templates.",
"name": "DisableTemplateSelectionFromPCA"
},
"EventList": {
"title": "Event List",
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList"
},
"SubscriberObjectId": {
"target": "/api/device/cuc/UserTemplate/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": true,
"name": "SubscriberObjectId",
"target_attr": "ObjectId",
"title": "Subscriber Object Id",
"type": [
"string"
],
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"target_model_type": "device/cuc/UserTemplate",
"choices": []
},
"ScheduleSetObjectId": {
"title": "Schedule Set Object Id",
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId"
},
"URI": {
"minItems": 0,
"title": "URI",
"type": "string",
"name": "URI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"UserURI": {
"minItems": 0,
"title": "User URI",
"type": "string",
"name": "UserURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"CallbackNumber": {
"minItems": 0,
"type": "string",
"name": "CallbackNumber",
"title": "Callback Number"
},
"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"
},
"NotificationTemplateID": {
"minItems": 0,
"title": "Notification Template ID",
"type": "string",
"description": " The unique identifier of the Notification Template object which this notification device is using for HTML based notification",
"name": "NotificationTemplateID"
},
"Active": {
"minItems": 0,
"title": "Active",
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active"
},
"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"
},
"Undeletable": {
"minItems": 0,
"title": "Undeletable",
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable"
},
"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"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cuc/UserTemplateHtmlDevice/add/ |
|
The GUI Add form of device/cuc/UserTemplateHtmlDevice as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/cuc/UserTemplateHtmlDevice | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cuc/UserTemplateHtmlDevice/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/UserTemplateHtmlDevice/[pkid1]", "/api/device/cuc/UserTemplateHtmlDevice/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/UserTemplateHtmlDevice/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/UserTemplateHtmlDevice/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/UserTemplateHtmlDevice/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/UserTemplateHtmlDevice/[pkid1]", "/api/v0/device/cuc/UserTemplateHtmlDevice/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/UserTemplateHtmlDevice/?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/UserTemplateHtmlDevice |
|
{"hrefs": ["/api/device/cuc/UserTemplateHtmlDevice/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/UserTemplateHtmlDevice |
|
{"hrefs": ["/api/device/cuc/UserTemplateHtmlDevice/[pkid1]", "/api/device/cuc/UserTemplateHtmlDevice/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/UserTemplateHtmlDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/UserTemplateHtmlDevice/export/ |
|
{ "hrefs":["/api/device/cuc/UserTemplateHtmlDevice/[pkid1]", "/api/device/cuc/UserTemplateHtmlDevice/[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/UserTemplateHtmlDevice and the JSON format can be used to import instances of device/cuc/UserTemplateHtmlDevice.
GET http://[host-proxy]/api/device/cuc/UserTemplateHtmlDevice/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/UserTemplateHtmlDevice | POST | /api/device/cuc/UserTemplateHtmlDevice/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/UserTemplateHtmlDevice/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/UserTemplateHtmlDevice/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/UserTemplateHtmlDevice/ |
|
The device/cuc/UserTemplateHtmlDevice schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/UserTemplateHtmlDevice instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 12,
"total_limit": null,
"order_by": "DisplayName",
"direction": "asc",
"current": "/api/device/cuc/UserTemplateHtmlDevice/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/cuc/UserTemplateHtmlDevice",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add",
"list",
"update",
"get",
"remove",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "14.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/cuc/UserTemplateHtmlDevice/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cuc/UserTemplateHtmlDevice/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cuc/UserTemplateHtmlDevice/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/UserTemplateHtmlDevice",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cuc/UserTemplateHtmlDevice/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/cuc/UserTemplateHtmlDevice/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cuc/UserTemplateHtmlDevice/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cuc/UserTemplateHtmlDevice/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cuc/UserTemplateHtmlDevice/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplateHtmlDevice/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplateHtmlDevice/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"DisableMobileNumberFromPCA": false,
"DisplayName": "HTML",
"DeviceName": "HTML",
"ObjectId": "f0a8b6d0-c923-4f0d-a917-a7f667f3140e",
"DisableTemplateSelectionFromPCA": false,
"hierarchy": "5ae89ea2affa931cce38a523",
"EventList": "NewVoiceMail",
"SubscriberObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838",
"URI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatenotificationdevices/usertemplatehtmldevices/f0a8b6d0-c923-4f0d-a917-a7f667f3140e",
"UserURI": "/vmrest/users/cdfadb1e-4b22-486c-ac60-5543558de813",
"NotificationTemplateID": "157d54c6-dd30-4690-a4e4-30831f00a63e",
"Active": false,
"Undeletable": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/UserTemplateHtmlDevice",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "HTML",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/",
"pkid": "5ae8a018affa931cce390745"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a018affa931cce390745"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a018affa931cce390745/?model_type=device/cuc/UserTemplateHtmlDevice",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a018affa931cce390745"
},
{
"data": {
"DisableMobileNumberFromPCA": false,
"DisplayName": "HTML",
"DeviceName": "HTML",
"ObjectId": "f0a8b6d0-c923-4f0d-a917-a7f667f3140e",
"DisableTemplateSelectionFromPCA": false,
"hierarchy": "5ae89ea2affa931cce38a523",
"EventList": "NewVoiceMail",
"SubscriberObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838",
"URI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatenotificationdevices/usertemplatehtmldevices/f0a8b6d0-c923-4f0d-a917-a7f667f3140e",
"UserURI": "/vmrest/users/cdfadb1e-4b22-486c-ac60-5543558de813",
"NotificationTemplateID": "157d54c6-dd30-4690-a4e4-30831f00a63e",
"Active": false,
"Undeletable": true,
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/UserTemplateHtmlDevice",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "HTML",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ef8affa931cce38ca95",
"pkid": "5ae89ef8affa931cce38ca95"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a029affa931cce390b7e/",
"pkid": "5ae8a029affa931cce390b7e"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a029affa931cce390b7e"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a029affa931cce390b7e/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a029affa931cce390b7e/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a029affa931cce390b7e/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a029affa931cce390b7e/?model_type=device/cuc/UserTemplateHtmlDevice",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a029affa931cce390b7e/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a029affa931cce390b7e/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a029affa931cce390b7e/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a029affa931cce390b7e/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a029affa931cce390b7e"
},
{
"data": {
"DisableMobileNumberFromPCA": false,
"DisplayName": "HTML",
"DeviceName": "HTML",
"ObjectId": "78c71a89-83b0-4892-aa69-3245c889c2ca",
"DisableTemplateSelectionFromPCA": false,
"hierarchy": "5ae89ea2affa931cce38a523",
"EventList": "NewVoiceMail",
"SubscriberObjectId": "11dd0513-3e17-4a38-aae4-1b647be8cc97",
"ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838",
"URI": "/vmrest/usertemplates/11dd0513-3e17-4a38-aae4-1b647be8cc97/usertemplatenotificationdevices/usertemplatehtmldevices/78c71a89-83b0-4892-aa69-3245c889c2ca",
"UserURI": "/vmrest/users/11dd0513-3e17-4a38-aae4-1b647be8cc97",
"NotificationTemplateID": "157d54c6-dd30-4690-a4e4-30831f00a63e",
"Active": false,
"Undeletable": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/UserTemplateHtmlDevice",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "HTML",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8b14eaffa931cce3d59cd/",
"pkid": "5ae8b14eaffa931cce3d59cd"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8b14eaffa931cce3d59cd"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8b14eaffa931cce3d59cd/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8b14eaffa931cce3d59cd/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8b14eaffa931cce3d59cd/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8b14eaffa931cce3d59cd/?model_type=device/cuc/UserTemplateHtmlDevice",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8b14eaffa931cce3d59cd/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8b14eaffa931cce3d59cd/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8b14eaffa931cce3d59cd/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8b14eaffa931cce3d59cd/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8b14eaffa931cce3d59cd"
}
]
}
(Show the first instance)
{
"data": {
"DisableMobileNumberFromPCA": false,
"DisplayName": "HTML",
"DeviceName": "HTML",
"ObjectId": "f0a8b6d0-c923-4f0d-a917-a7f667f3140e",
"DisableTemplateSelectionFromPCA": false,
"EventList": "NewVoiceMail",
"SubscriberObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838",
"URI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatenotificationdevices/usertemplatehtmldevices/f0a8b6d0-c923-4f0d-a917-a7f667f3140e",
"UserURI": "/vmrest/users/cdfadb1e-4b22-486c-ac60-5543558de813",
"NotificationTemplateID": "157d54c6-dd30-4690-a4e4-30831f00a63e",
"Active": false,
"Undeletable": true
},
"meta": {
"model_type": "device/cuc/UserTemplateHtmlDevice",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "HTML",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/",
"pkid": "5ae8a018affa931cce390745"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a018affa931cce390745"
],
"schema_version": "11.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a018affa931cce390745/?hierarchy=[hierarchy]&model_type=device/cuc/UserTemplateHtmlDevice",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplateHtmlDevice/5ae8a018affa931cce390745/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "5ae8a018affa931cce390745"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/UserTemplateHtmlDevice. | GET | /api/device/cuc/UserTemplateHtmlDevice/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/UserTemplateHtmlDevice as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/UserTemplateHtmlDevice/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/UserTemplateHtmlDevice/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cuc/UserTemplateHtmlDevice/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/UserTemplateHtmlDevice/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/UserTemplateHtmlDevice/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/UserTemplateHtmlDevice | 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/UserTemplateHtmlDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/UserTemplateHtmlDevice/[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/UserTemplateHtmlDevice and the JSON format can be used to import instances of device/cuc/UserTemplateHtmlDevice.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/UserTemplateHtmlDevice/[pkid] | hierarchy=[hierarchy] | The device/cuc/UserTemplateHtmlDevice instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/UserTemplateHtmlDevice/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/UserTemplateHtmlDevice. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/UserTemplateHtmlDevice/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |