[Index]
Model ref.: device/cuc/HtmlDevice
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": { "DisplayName": { "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. ", "title": "Display Name", "minItems": 0, "required": true, "type": "string", "name": "DisplayName" }, "UserURI": { "name": "UserURI", "title": "User URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "DeviceName": { "description": " The \"DeviceName\" of the notification device.", "title": "Device Name", "minItems": 0, "readonly": true, "type": "string", "name": "DeviceName" }, "SendScheduledNotificationAt": { "title": "Send Scheduled Notification At", "type": "string", "description": "Comma separated list of time slots at which scheduled notification will be triggered at daily basis.", "name": "SendScheduledNotificationAt" }, "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/User", "title": "Subscriber Object Id", "type": [ "string" ], "target": "/api/device/cuc/User/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" }, "Active": { "minItems": 0, "title": "Active", "type": "boolean", "description": " A flag indicating whether the device is active or inactive (enabled/disabled).", "name": "Active" }, "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" }, "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 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" }, "URI": { "name": "URI", "title": "URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "AllowVoiceMailAsAttachment": { "minItems": 0, "title": "Allow Voice Mail As Attachment", "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection will allow notifier to send voice mail recording with the notification.", "name": "AllowVoiceMailAsAttachment" }, "MessageCountInSummary": { "minItems": 0, "title": "Message Count In Summary", "type": "integer", "description": " Field to store number of messages to be sent in summary notification mail", "name": "MessageCountInSummary" }, "Undeletable": { "minItems": 0, "title": "Undeletable", "type": "boolean", "description": "Device cannot be deleted.", "name": "Undeletable" }, "CallbackNumber": { "minItems": 0, "type": "string", "name": "CallbackNumber", "title": "Callback Number" }, "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" }, "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" }, "NotificationTemplateID": { "description": " The unique identifier of the Notification Template object which this notification device is using for HTML based notification", "name": "NotificationTemplateID", "title": "Notification Template ID", "minItems": 0, "format": "uri", "choices": [], "target_attr": "NotificationTemplateID", "target_model_type": "device/cuc/NotificationTemplate", "type": [ "string" ], "target": "/api/device/cuc/NotificationTemplate/choices/?field=NotificationTemplateID&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "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" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/HtmlDevice/add/ |
|
The GUI Add form of device/cuc/HtmlDevice 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/HtmlDevice/ | 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/HtmlDevice/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/HtmlDevice/[pkid1]", "/api/device/cuc/HtmlDevice/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/HtmlDevice/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/HtmlDevice/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/HtmlDevice/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/HtmlDevice/[pkid1]", "/api/v0/device/cuc/HtmlDevice/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/HtmlDevice/?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/HtmlDevice |
|
{"hrefs": ["/api/device/cuc/HtmlDevice/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/HtmlDevice |
|
{"hrefs": ["/api/device/cuc/HtmlDevice/[pkid1]", "/api/device/cuc/HtmlDevice/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/HtmlDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/HtmlDevice/export/ |
|
{ "hrefs":["/api/device/cuc/HtmlDevice/[pkid1]", "/api/device/cuc/HtmlDevice/[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/HtmlDevice and the JSON format can be used to import instances of device/cuc/HtmlDevice.
GET http://[host-proxy]/api/device/cuc/HtmlDevice/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/HtmlDevice | POST | /api/device/cuc/HtmlDevice/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/HtmlDevice/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/HtmlDevice/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/HtmlDevice/ |
|
The device/cuc/HtmlDevice schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/HtmlDevice instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/HtmlDevice/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 268 }, "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": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/cuc/HtmlDevice/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/HtmlDevice/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/HtmlDevice/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/HtmlDevice", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/HtmlDevice/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/HtmlDevice/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/HtmlDevice/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/HtmlDevice/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/HtmlDevice/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/HtmlDevice/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/HtmlDevice/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/HtmlDevice", "model_specific_actions": [ "add", "list", "update", "get", "remove", "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": "61b1329beadb826afd7c9150", "meta": { "tags": [], "cached": true, "title": "HTML", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "61b12f13eadb826afd7b7dd9", "href": "/api/v0/data/UnityConnection/61b12f13eadb826afd7b7dd9" } ], "self": [ { "pkid": "61b1329beadb826afd7c9150", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/" } ], "parent": [ { "pkid": "61b12e93eadb826afd7b5dad", "href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/61b1329beadb826afd7c9150/?model_type=device/cuc/HtmlDevice", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/HtmlDevice", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b1329beadb826afd7c9150" ], "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": { "DeviceName": "HTML", "SendScheduledNotificationAt": "", "DisplayName": "HTML", "ObjectId": "a6069492-4d77-4d1c-8580-199cc6a34425", "DisableMobileNumberFromPCA": false, "hierarchy": "61b12e93eadb826afd7b5dad", "EventList": "NewVoiceMail", "SubscriberObjectId": "876e199f-5098-4f0f-a86a-d02de83e24fe", "DisableTemplateSelectionFromPCA": false, "ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838", "URI": "/vmrest/users/876e199f-5098-4f0f-a86a-d02de83e24fe/notificationdevices/htmldevices/a6069492-4d77-4d1c-8580-199cc6a34425", "UserURI": "/vmrest/users/876e199f-5098-4f0f-a86a-d02de83e24fe", "AllowVoiceMailAsAttachment": false, "MessageCountInSummary": 10, "NotificationTemplateID": "157d54c6-dd30-4690-a4e4-30831f00a63e", "Active": false, "hierarchy_friendly_name": "CS-P (Provider)", "summary_device": "Partitioned CUCxn, 192.168.100.22, 8443, hcs.CS-P", "Undeletable": true, "hierarchy_path": "sys.hcs.CS-P" } }, { "pkid": "61b132a1eadb826afd7c933b", "meta": { "tags": [], "cached": true, "title": "HTML", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "61b12f13eadb826afd7b7dd9", "href": "/api/v0/data/UnityConnection/61b12f13eadb826afd7b7dd9" } ], "self": [ { "pkid": "61b132a1eadb826afd7c933b", "href": "/api/device/cuc/HtmlDevice/61b132a1eadb826afd7c933b/" } ], "parent": [ { "pkid": "61b12e93eadb826afd7b5dad", "href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/device/cuc/HtmlDevice/61b132a1eadb826afd7c933b/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/device/cuc/HtmlDevice/61b132a1eadb826afd7c933b/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/device/cuc/HtmlDevice/61b132a1eadb826afd7c933b/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/61b132a1eadb826afd7c933b/?model_type=device/cuc/HtmlDevice", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/HtmlDevice/61b132a1eadb826afd7c933b/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cuc/HtmlDevice/61b132a1eadb826afd7c933b/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cuc/HtmlDevice/61b132a1eadb826afd7c933b/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/cuc/HtmlDevice/61b132a1eadb826afd7c933b/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/cuc/HtmlDevice", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b132a1eadb826afd7c933b" ], "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": { "DeviceName": "HTML", "SendScheduledNotificationAt": "", "DisplayName": "HTML", "ObjectId": "9aac3adb-63c7-4dfc-ac40-f29e694da973", "DisableMobileNumberFromPCA": false, "hierarchy": "61b12e93eadb826afd7b5dad", "EventList": "NewVoiceMail", "SubscriberObjectId": "00d60898-da5e-4e91-ab0d-b54a460833c0", "DisableTemplateSelectionFromPCA": false, "ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838", "URI": "/vmrest/users/00d60898-da5e-4e91-ab0d-b54a460833c0/notificationdevices/htmldevices/9aac3adb-63c7-4dfc-ac40-f29e694da973", "UserURI": "/vmrest/users/00d60898-da5e-4e91-ab0d-b54a460833c0", "AllowVoiceMailAsAttachment": false, "MessageCountInSummary": 10, "NotificationTemplateID": "157d54c6-dd30-4690-a4e4-30831f00a63e", "Active": false, "hierarchy_friendly_name": "CS-P (Provider)", "summary_device": "Partitioned CUCxn, 192.168.100.22, 8443, hcs.CS-P", "Undeletable": true, "hierarchy_path": "sys.hcs.CS-P" } }, { "pkid": "61b13334eadb826afd7caf30", "meta": { "tags": [], "cached": true, "title": "HTML", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "61b12f56eadb826afd7b8db9", "href": "/api/v0/data/UnityConnection/61b12f56eadb826afd7b8db9" } ], "self": [ { "pkid": "61b13334eadb826afd7caf30", "href": "/api/device/cuc/HtmlDevice/61b13334eadb826afd7caf30/" } ], "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/device/cuc/HtmlDevice/61b13334eadb826afd7caf30/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/device/cuc/HtmlDevice/61b13334eadb826afd7caf30/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cuc/HtmlDevice/61b13334eadb826afd7caf30/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/61b13334eadb826afd7caf30/?model_type=device/cuc/HtmlDevice", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/device/cuc/HtmlDevice/61b13334eadb826afd7caf30/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cuc/HtmlDevice/61b13334eadb826afd7caf30/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cuc/HtmlDevice/61b13334eadb826afd7caf30/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cuc/HtmlDevice/61b13334eadb826afd7caf30/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/cuc/HtmlDevice", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b13334eadb826afd7caf30" ], "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": { "DeviceName": "HTML", "SendScheduledNotificationAt": "", "DisplayName": "HTML", "ObjectId": "6bd5cb34-071d-4286-886d-7e6855ac8322", "DisableMobileNumberFromPCA": false, "hierarchy": "61b12edfeadb826afd7b715a", "EventList": "NewVoiceMail", "SubscriberObjectId": "5d0c7871-e805-4316-836d-87b0d265cb3d", "DisableTemplateSelectionFromPCA": false, "ScheduleSetObjectId": "1729b420-bf89-47e2-a44a-ff5e81761566", "URI": "/vmrest/users/5d0c7871-e805-4316-836d-87b0d265cb3d/notificationdevices/htmldevices/6bd5cb34-071d-4286-886d-7e6855ac8322", "UserURI": "/vmrest/users/5d0c7871-e805-4316-836d-87b0d265cb3d", "AllowVoiceMailAsAttachment": false, "MessageCountInSummary": 10, "NotificationTemplateID": "60705aef-a3b9-49ba-970a-51babfab4c10", "Active": false, "hierarchy_friendly_name": "AAAGlobal (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal", "Undeletable": true, "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } } ] }
(Show the first instance)
{ "pkid": "61b1329beadb826afd7c9150", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "HTML", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "61b12e93eadb826afd7b5dad", "href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad" } ], "self": [ { "pkid": "61b1329beadb826afd7c9150", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/" } ], "foreign_key": [], "owner": [ { "pkid": "" } ], "device": [ { "pkid": "61b12f13eadb826afd7b7dd9", "href": "/api/v0/data/UnityConnection/61b12f13eadb826afd7b7dd9" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/61b1329beadb826afd7c9150/?hierarchy=[hierarchy]&model_type=device/cuc/HtmlDevice", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/HtmlDevice/61b1329beadb826afd7c9150/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/HtmlDevice", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b1329beadb826afd7c9150" ], "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": { "DeviceName": "HTML", "SendScheduledNotificationAt": "", "DisplayName": "HTML", "ObjectId": "a6069492-4d77-4d1c-8580-199cc6a34425", "DisableMobileNumberFromPCA": false, "EventList": "NewVoiceMail", "SubscriberObjectId": "876e199f-5098-4f0f-a86a-d02de83e24fe", "DisableTemplateSelectionFromPCA": false, "ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838", "URI": "/vmrest/users/876e199f-5098-4f0f-a86a-d02de83e24fe/notificationdevices/htmldevices/a6069492-4d77-4d1c-8580-199cc6a34425", "UserURI": "/vmrest/users/876e199f-5098-4f0f-a86a-d02de83e24fe", "AllowVoiceMailAsAttachment": false, "MessageCountInSummary": 10, "NotificationTemplateID": "157d54c6-dd30-4690-a4e4-30831f00a63e", "Active": false, "Undeletable": true } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/HtmlDevice. | GET | /api/device/cuc/HtmlDevice/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/HtmlDevice as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/HtmlDevice/[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/HtmlDevice/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/HtmlDevice/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/HtmlDevice/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/HtmlDevice | 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/HtmlDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/HtmlDevice/[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/HtmlDevice and the JSON format can be used to import instances of device/cuc/HtmlDevice.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/HtmlDevice/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/HtmlDevice instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/HtmlDevice/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/HtmlDevice. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/HtmlDevice/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |