[Index]
Model ref.: device/cuc/UserTemplateSmtpDevice
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": {
"minItems": 0,
"type": "string",
"description": " The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Home Phone,\" Pager 2,\" \"Work Phone, \" etc. ",
"name": "DisplayName",
"title": "Display Name"
},
"StaticText": {
"minItems": 0,
"type": "string",
"description": " The actual text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the \"Send:\" field.\n",
"name": "StaticText",
"title": "Static Text"
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SendCount": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message. ",
"name": "SendCount",
"title": "Send Count"
},
"MaxSubject": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject",
"title": "Max Subject"
},
"MaxBody": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody",
"title": "Max Body"
},
"UrgentOnly": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection sends voice message transcripted in urgent mode or not",
"name": "UrgentOnly",
"title": "Urgent Only"
},
"SubscriberObjectId": {
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"title": "Subscriber Object Id",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/UserTemplate/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/UserTemplate",
"type": [
"string"
],
"name": "SubscriberObjectId"
},
"ScheduleSetObjectId": {
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId",
"title": "Schedule Set Object Id"
},
"HeaderText": {
"minItems": 0,
"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",
"title": "Header Text"
},
"FooterText": {
"minItems": 0,
"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",
"title": "Footer Text"
},
"Active": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active",
"title": "Active"
},
"SmtpAddress": {
"minItems": 0,
"type": "string",
"description": " The e-mail address of the text pager, text-compatible cell phone, or another e-mail account (such as a home e-mail address) to which the notification message is to be sent. In the SA, this is referred to as the \"To:\" field.",
"name": "SmtpAddress",
"title": "Smtp Address"
},
"RepeatInterval": {
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval",
"title": "Repeat Interval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMTP object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"EventList": {
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList",
"title": "Event List"
},
"SendCallerId": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ",
"name": "SendCallerId",
"title": "Send Caller Id"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PhoneNumber": {
"minItems": 0,
"type": "string",
"description": " The phone number or alphanumeric text (as applicable) for sending a notification message to a text-compatible cell phone or pager. In the SA, this is referred to as the \"From:\" field. Typically, this field contains the number that the subscriber calls to check messages. ",
"name": "PhoneNumber",
"title": "Phone Number"
},
"Undeletable": {
"minItems": 0,
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable",
"title": "Undeletable"
},
"VoiceMessage": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection sends transcription of voice message",
"name": "VoiceMessage",
"title": "Voice Message"
},
"SendPcaLink": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include a link to the PCA with the notification message. ",
"name": "SendPcaLink",
"title": "Send Pca Link"
},
"FailDeviceObjectId": {
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId",
"title": "Fail Device Object Id"
},
"InitialDelay": {
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay",
"title": "Initial Delay"
},
"RepeatNotify": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify",
"title": "Repeat Notify"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cuc/UserTemplateSmtpDevice/add/ |
|
The GUI Add form of device/cuc/UserTemplateSmtpDevice 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/UserTemplateSmtpDevice | 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/UserTemplateSmtpDevice/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/UserTemplateSmtpDevice/[pkid1]", "/api/device/cuc/UserTemplateSmtpDevice/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/UserTemplateSmtpDevice/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/UserTemplateSmtpDevice/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/UserTemplateSmtpDevice/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/UserTemplateSmtpDevice/[pkid1]", "/api/v0/device/cuc/UserTemplateSmtpDevice/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/UserTemplateSmtpDevice/?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/UserTemplateSmtpDevice |
|
{"hrefs": ["/api/device/cuc/UserTemplateSmtpDevice/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/UserTemplateSmtpDevice |
|
{"hrefs": ["/api/device/cuc/UserTemplateSmtpDevice/[pkid1]", "/api/device/cuc/UserTemplateSmtpDevice/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/UserTemplateSmtpDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/UserTemplateSmtpDevice/export/ |
|
{ "hrefs":["/api/device/cuc/UserTemplateSmtpDevice/[pkid1]", "/api/device/cuc/UserTemplateSmtpDevice/[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/UserTemplateSmtpDevice and the JSON format can be used to import instances of device/cuc/UserTemplateSmtpDevice.
GET http://[host-proxy]/api/device/cuc/UserTemplateSmtpDevice/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/UserTemplateSmtpDevice | POST | /api/device/cuc/UserTemplateSmtpDevice/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/UserTemplateSmtpDevice/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/UserTemplateSmtpDevice/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/UserTemplateSmtpDevice/ |
|
The device/cuc/UserTemplateSmtpDevice schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/UserTemplateSmtpDevice instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/UserTemplateSmtpDevice/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 2
},
"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/UserTemplateSmtpDevice/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/UserTemplateSmtpDevice/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/UserTemplateSmtpDevice/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/UserTemplateSmtpDevice",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplateSmtpDevice/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/UserTemplateSmtpDevice/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/UserTemplateSmtpDevice/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/UserTemplateSmtpDevice/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/UserTemplateSmtpDevice/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/UserTemplateSmtpDevice/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/UserTemplateSmtpDevice/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplateSmtpDevice",
"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": "5f3ae7efce894e001205b969",
"meta": {
"tags": [],
"cached": true,
"title": "SMTP",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae7efce894e001205b969",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae7efce894e001205b969/?model_type=device/cuc/UserTemplateSmtpDevice",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplateSmtpDevice",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae7efce894e001205b969"
],
"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": {
"DisplayName": "SMTP",
"UserURI": "/vmrest/users/cdfadb1e-4b22-486c-ac60-5543558de813",
"SendCount": true,
"hierarchy_friendly_name": "AB_Group (Customer)",
"MaxSubject": 64,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"DeviceName": "SMTP",
"UrgentOnly": false,
"SubscriberObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838",
"Active": false,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"RepeatInterval": 0,
"ObjectId": "dc78b110-a30a-4818-bd71-211ba51fe80a",
"MaxBody": 512,
"EventList": "NewVoiceMail",
"SendCallerId": true,
"URI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatenotificationdevices/usertemplatesmtpdevices/dc78b110-a30a-4818-bd71-211ba51fe80a",
"Undeletable": true,
"VoiceMessage": false,
"SendPcaLink": false,
"InitialDelay": 0,
"RepeatNotify": false
}
},
{
"pkid": "5f3aeb40ce894e001206bc68",
"meta": {
"tags": [],
"cached": true,
"title": "SMTP",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3aeb40ce894e001206bc68",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3aeb40ce894e001206bc68/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3aeb40ce894e001206bc68/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3aeb40ce894e001206bc68/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3aeb40ce894e001206bc68/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3aeb40ce894e001206bc68/?model_type=device/cuc/UserTemplateSmtpDevice",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3aeb40ce894e001206bc68/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3aeb40ce894e001206bc68/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3aeb40ce894e001206bc68/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3aeb40ce894e001206bc68/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/UserTemplateSmtpDevice",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3aeb40ce894e001206bc68"
],
"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": {
"DisplayName": "SMTP",
"UserURI": "/vmrest/users/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e",
"SendCount": true,
"hierarchy_friendly_name": "AB_Group (Customer)",
"MaxSubject": 64,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"DeviceName": "SMTP",
"UrgentOnly": false,
"SubscriberObjectId": "acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e",
"ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838",
"Active": false,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"RepeatInterval": 0,
"ObjectId": "ec0810be-ab16-4223-ac5e-cf0d7e218f91",
"MaxBody": 512,
"EventList": "NewVoiceMail",
"SendCallerId": true,
"URI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/usertemplatenotificationdevices/usertemplatesmtpdevices/ec0810be-ab16-4223-ac5e-cf0d7e218f91",
"Undeletable": true,
"VoiceMessage": false,
"SendPcaLink": false,
"InitialDelay": 0,
"RepeatNotify": false
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae7efce894e001205b969",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "SMTP",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae7efce894e001205b969",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae7efce894e001205b969/?hierarchy=[hierarchy]&model_type=device/cuc/UserTemplateSmtpDevice",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/UserTemplateSmtpDevice/5f3ae7efce894e001205b969/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplateSmtpDevice",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae7efce894e001205b969"
],
"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": {
"MaxBody": 512,
"MaxSubject": 64,
"DisplayName": "SMTP",
"DeviceName": "SMTP",
"ObjectId": "dc78b110-a30a-4818-bd71-211ba51fe80a",
"UrgentOnly": false,
"EventList": "NewVoiceMail",
"SubscriberObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"VoiceMessage": false,
"SendCallerId": true,
"URI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatenotificationdevices/usertemplatesmtpdevices/dc78b110-a30a-4818-bd71-211ba51fe80a",
"UserURI": "/vmrest/users/cdfadb1e-4b22-486c-ac60-5543558de813",
"InitialDelay": 0,
"RepeatInterval": 0,
"RepeatNotify": false,
"SendCount": true,
"SendPcaLink": false,
"Active": false,
"ScheduleSetObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838",
"Undeletable": true
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/UserTemplateSmtpDevice. | GET | /api/device/cuc/UserTemplateSmtpDevice/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/UserTemplateSmtpDevice as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/UserTemplateSmtpDevice/[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/UserTemplateSmtpDevice/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/UserTemplateSmtpDevice/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/UserTemplateSmtpDevice/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/UserTemplateSmtpDevice | 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/UserTemplateSmtpDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/UserTemplateSmtpDevice/[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/UserTemplateSmtpDevice and the JSON format can be used to import instances of device/cuc/UserTemplateSmtpDevice.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/UserTemplateSmtpDevice/[pkid] | hierarchy=[hierarchy] | The device/cuc/UserTemplateSmtpDevice instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/UserTemplateSmtpDevice/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/UserTemplateSmtpDevice. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/UserTemplateSmtpDevice/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |