[Index]
Manage HTML email templates.
Model ref.: data/EmailHtmlTemplate
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": { "subject": { "required": true, "type": "string", "description": "Subject of the email.", "title": "Subject" }, "from": { "title": "From Email address", "type": "string", "description": "From Email address.", "format": "email" }, "name": { "choices": [ { "value": "Quick Add Subscriber", "title": "Quick Add Subscriber" }, { "value": "Number Inventory Alerting", "title": "Number Inventory Alerting" }, { "value": "Test Email Template", "title": "Test Email Template" }, { "value": "DR Activation", "title": "DR Activation" } ], "required": true, "type": "string", "description": "Name of the Email HTML Template.", "title": "Name" }, "html_template": { "required": true, "type": "string", "description": "HTML Email Template. An online tool can be used to setup the template. Simply copy and paste the HTML in this text area.", "title": "HTML Template" }, "description": { "type": "string", "description": "Description of the Email HTML Template.", "title": "Description" } }, "schema_version": "2.2" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/EmailHtmlTemplate/add/ |
|
The GUI Add form of data/EmailHtmlTemplate 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/data/EmailHtmlTemplate | 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/data/EmailHtmlTemplate/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/EmailHtmlTemplate/[pkid1]", "/api/data/EmailHtmlTemplate/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/EmailHtmlTemplate/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/EmailHtmlTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/EmailHtmlTemplate/export/ |
|
{ "hrefs":["/api/data/EmailHtmlTemplate/[pkid1]", "/api/data/EmailHtmlTemplate/[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 data/EmailHtmlTemplate and the JSON format can be used to import instances of data/EmailHtmlTemplate.
GET http://[host-proxy]/api/data/EmailHtmlTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/EmailHtmlTemplate | POST | /api/data/EmailHtmlTemplate/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/EmailHtmlTemplate/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/EmailHtmlTemplate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/EmailHtmlTemplate/ |
|
The data/EmailHtmlTemplate schema and all instances as JSON. |
(The list will return 0 to 3 data/EmailHtmlTemplate instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "move", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/EmailHtmlTemplate/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 5 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": { "hierarchy": true, "consider_null": false, "unique": [ "name" ] }, "schema_version": "2.2", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/data/EmailHtmlTemplate/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/EmailHtmlTemplate/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/EmailHtmlTemplate/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/data/EmailHtmlTemplate/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/EmailHtmlTemplate/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/EmailHtmlTemplate/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/EmailHtmlTemplate/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/EmailHtmlTemplate/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/EmailHtmlTemplate/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/EmailHtmlTemplate", "model_specific_actions": [ "add", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "remove", "tag", "update" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "655ed1d27667e9f1292dc074", "meta": { "tags": [ "V4UC", "ba_CommonOverlay" ], "cached": true, "title": "DR Activation", "business_key": { "hierarchy": true, "consider_null": false, "unique": [ "name" ] }, "schema_version": "2.2", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "655ed1d27667e9f1292dc074", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/help", "method": "GET", "title": "Help" } } ], "model_type": "data/EmailHtmlTemplate", "path": [ "6t0ggef2c0deab00hb595101", "655ed1d27667e9f1292dc074" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "from": "[email protected]", "description": "DR Activation notification", "pkid": "655ed1d27667e9f1292dc075", "name": "DR Activation", "hierarchy_friendly_name": "sys (System)", "subject": "DR activation", "html_template": "<table id=\"main\" border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"0\" bgcolor=\"#F9F9F9\">\n<tbody>\n<tr>\n<td valign=\"top\">\n<table class=\"innermain\" style=\"margin: 0 auto; table-layout: fixed;\" border=\"0\" width=\"440\" cellspacing=\"0\" cellpadding=\"0\" align=\"center\" bgcolor=\"#F9F9F9\">\n<tbody>\n<tr>\n<td colspan=\"4\">\n<table style=\"box-shadow: 0 0 5px #E6E6E6; border: 1px solid #EFEFEF;\" border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"0\" bgcolor=\"#ffffff\">\n<tbody>\n<tr>\n<td height=\"20\"> </td>\n</tr>\n<tr>\n<td style=\"text-align: center;\" height=\"20\"> <img src=\"https://www.google.com/a/cpanel/voss-solutions.com/images/logo.gif?service=google_gsuite\" alt=\"Voss Solutions\" width=\"400\" height=\"135\" /></td>\n</tr>\n<tr style=\"font-family: Arial, Helvetica, sans-serif; color: #666666; font-size: 14px; line-height: 20px; margin-top: 20px;\">\n<td class=\"content\" style=\"padding-left: 40px; padding-right: 40px;\" colspan=\"2\" align=\"center\" valign=\"top\">\n<table border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"0\" bgcolor=\"#ffffff\">\n<tbody>\n<tr>\n<td height=\"30\"> </td>\n</tr>\n<tr>\n<td align=\"center\"><span style=\"color: #48545d; font-size: 22px; line-height: 24px;\"><span style=\"color: #48545d; font-size: 22px; line-height: 24px;\">Disaster Recovery Notice</span></span></td>\n</tr>\n<tr>\n<td height=\"30\"> </td>\n</tr>\n<tr>\n<td align=\"center\">\n<p><span style=\"color: #48545d; font-size: 14px; line-height: 24px;\">THIS IS A DR ACTIVATION NOTIFICATION EMAIL</span></p>\n<p><span style=\"color: #48545d; font-size: 14px; line-height: 24px;\">The following DR plan has been {{ pwf.EMAIL.status }}</span></p>\n<p><span style=\"color: #48545d; font-size: 14px; line-height: 24px;\">{{ pwf.EMAIL.plans }}</span></p>\n</td>\n</tr>\n<tr>\n<td height=\"20\"> </td>\n</tr>\n<tr>\n<td align=\"center\" valign=\"top\" width=\"48%\"><a style=\"display: block; padding: 15px 25px; background-color: #0c3c73; color: #ffffff; border-radius: 3px; text-decoration: none;\" href=\"https://www.voss-solutions.com/\">Voss Solutions</a></td>\n</tr>\n<tr>\n<td height=\"20\"> </td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>", "hierarchy_path": "sys" } }, { "pkid": "6260cecfa96ee2847bf68f00", "meta": { "tags": [ "number_inventory_alerting", "V4UC", "ba_CommonOverlay" ], "cached": true, "title": "Number Inventory Alerting", "business_key": { "hierarchy": true, "consider_null": false, "unique": [ "name" ] }, "schema_version": "2.2", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "6260cecfa96ee2847bf68f00", "href": "/api/data/EmailHtmlTemplate/6260cecfa96ee2847bf68f00/" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/data/EmailHtmlTemplate/6260cecfa96ee2847bf68f00/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/data/EmailHtmlTemplate/6260cecfa96ee2847bf68f00/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/data/EmailHtmlTemplate/6260cecfa96ee2847bf68f00/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/EmailHtmlTemplate/6260cecfa96ee2847bf68f00/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "class": "tag", "href": "/api/data/EmailHtmlTemplate/6260cecfa96ee2847bf68f00/+tag/", "method": "PATCH", "view": "/api/view/TagNameForm/add/" } }, { "get": { "support_async": false, "href": "/api/data/EmailHtmlTemplate/6260cecfa96ee2847bf68f00/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/data/EmailHtmlTemplate/6260cecfa96ee2847bf68f00/help", "title": "Help", "class": "help", "method": "GET" } } ], "model_type": "data/EmailHtmlTemplate", "path": [ "6t0ggef2c0deab00hb595101", "6260cecfa96ee2847bf68f00" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "from": "[email protected]", "name": "Number Inventory Alerting", "pkid": "6260cecfa96ee2847bf68f01", "description": "HTML Email Template for Number Inventory Alerting", "hierarchy_friendly_name": "sys (System)", "subject": "Number Inventory Threshold ({{ pwf.INI_ALERT_THRESHOLD }}%) Exceeded Alert for {{ pwf.INI_ALERT_HIERARCHY_NODE_TYPE }} {{ pwf.INI_ALERT_HIERARCHY_NAME }}", "html_template": "<h1>Number Inventory Threshold Report</h1>\n<table border='1' style='border-collapse:collapse'>\n<tr><td><b>Hierarchy node name</b></td><td><center>{{ pwf.INI_ALERT_HIERARCHY_NAME }}</center></td></tr>\n<tr><td><b>Hierarchy node type</b></td><td><center>{{ pwf.INI_ALERT_HIERARCHY_NODE_TYPE }}</center></td></tr>\n<tr><td><b>Hierarchy full path</b></td><td><center>{{ pwf.INI_ALERT_HIERARCHY }}</center></td></tr>\n<tr><td><b>Total numbers available</b></td><td><center>{{ pwf.INI_ALERT_TOTAL_INI_AVAILABLE }}</center></td></tr>\n<tr><td><b>Total numbers</b></td><td><center>{{ pwf.INI_ALERT_TOTAL_INI_COUNT }}</center></td></tr>\n<tr><td><b>Total percent available</b></td><td><center>{{ pwf.INI_ALERT_TOTAL_PERCENT_AVAILABLE }}%</center></td></tr>\n</table>\n<p></p>\n<p>{{ pwf.INI_ALERT_NODES_EXCEEDED_THRESHOLD_TABLE }}</p>\n<p> </p>\n<p> </p>\n<p> </p>\n<div>PLEASE DO NOT REPLY TO THIS EMAIL</div>\n<hr />\n<p> <img src=\"https://www.google.com/a/cpanel/voss-solutions.com/images/logo.gif?service=google_gsuite\" alt=\"Voss Solutions\" width=\"342\" height=\"115\" /></p>", "hierarchy_path": "sys" } }, { "pkid": "5df36767ce894e0012b3a755", "meta": { "tags": [ "email", "V4UC", "ba_CommonOverlay" ], "cached": true, "title": "Quick Add Subscriber", "business_key": { "hierarchy": true, "consider_null": false, "unique": [ "name" ] }, "schema_version": "2.2", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5df36767ce894e0012b3a755", "href": "/api/data/EmailHtmlTemplate/5df36767ce894e0012b3a755/" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/data/EmailHtmlTemplate/5df36767ce894e0012b3a755/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/data/EmailHtmlTemplate/5df36767ce894e0012b3a755/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/data/EmailHtmlTemplate/5df36767ce894e0012b3a755/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/data/EmailHtmlTemplate/5df36767ce894e0012b3a755/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "class": "tag", "href": "/api/data/EmailHtmlTemplate/5df36767ce894e0012b3a755/+tag/", "method": "PATCH", "view": "/api/view/TagNameForm/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/data/EmailHtmlTemplate/5df36767ce894e0012b3a755/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/data/EmailHtmlTemplate/5df36767ce894e0012b3a755/help", "class": "help", "title": "Help" } } ], "model_type": "data/EmailHtmlTemplate", "path": [ "6t0ggef2c0deab00hb595101", "5df36767ce894e0012b3a755" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "from": "[email protected]", "description": "HTML Email Template for Quick Add Subscriber", "pkid": "5df36767ce894e0012b3a756", "name": "Quick Add Subscriber", "hierarchy_friendly_name": "sys (System)", "subject": "Welcome {{ pwf.EMAIL.firstname }}", "html_template": "<table id=\"main\" border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"0\" bgcolor=\"#F9F9F9\">\n<tbody>\n<tr>\n<td valign=\"top\">\n<table class=\"innermain\" style=\"margin: 0 auto; table-layout: fixed;\" border=\"0\" width=\"440\" cellspacing=\"0\" cellpadding=\"0\" align=\"center\" bgcolor=\"#F9F9F9\">\n<tbody>\n<tr>\n<td colspan=\"4\">\n<table style=\"box-shadow: 0 0 5px #E6E6E6; border: 1px solid #EFEFEF;\" border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"0\" bgcolor=\"#ffffff\">\n<tbody>\n<tr>\n<td height=\"20\"> </td>\n</tr>\n<tr>\n<td style=\"text-align: center;\" height=\"20\"> <img src=\"https://www.google.com/a/cpanel/voss-solutions.com/images/logo.gif?service=google_gsuite\" alt=\"Voss Solutions\" width=\"400\" height=\"135\" /></td>\n</tr>\n<tr style=\"font-family: Arial, Helvetica, sans-serif; color: #666666; font-size: 14px; line-height: 20px; margin-top: 20px;\">\n<td class=\"content\" style=\"padding-left: 40px; padding-right: 40px;\" colspan=\"2\" align=\"center\" valign=\"top\">\n<table border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"0\" bgcolor=\"#ffffff\">\n<tbody>\n<tr>\n<td height=\"30\"> </td>\n</tr>\n<tr>\n<td align=\"center\"><span style=\"color: #48545d; font-size: 22px; line-height: 24px;\"><span style=\"color: #48545d; font-size: 22px; line-height: 24px;\"> Welcome {{ pwf.EMAIL.firstname }}</span></span></td>\n</tr>\n<tr>\n<td height=\"30\"> </td>\n</tr>\n<tr>\n<td align=\"center\">\n<p><span style=\"color: #48545d; font-size: 14px; line-height: 24px;\">THIS IS A TEST EMAIL</span></p>\n<p><span style=\"color: #48545d; font-size: 14px; line-height: 24px;\">You have been signed up for phone services.</span></p>\n<p><span style=\"color: #48545d;\">To access your account and set up your services, you must first log in and update your password.</span></p>\n<p><span style=\"color: #48545d;\">Username: {{ pwf.EMAIL.username }}</span></p>\n <p><span style=\"color: #48545d;\">First name: {{ pwf.EMAIL.firstname }}</span></p>\n<p><span style=\"color: #48545d;\">Last name: {{ pwf.EMAIL.lastname }}</span></p>\n<p><span style=\"color: #48545d;\">One time password: {{ pwf.EMAIL.password }}</span></p>\n<p><span style=\"color: #48545d;\">One time PIN: {{ pwf.EMAIL.pin }}</span></p>\n<p><span style=\"color: #48545d;\">Email: {{ pwf.EMAIL.email }}</span></p>\n<p><span style=\"color: #48545d;\">Extension: {{ pwf.EMAIL.extension_number }}</span></p>\n<p><span style=\"color: #48545d;\">Mobile Number: {{ pwf.EMAIL.mobile_number }}</span></p>\n<p><span style=\"color: #48545d;\">Entitlement Profile: {{ pwf.EMAIL.entitlement_profile }}</span></p>\n<p><span style=\"color: #48545d;\">Access Code: {{ pwf.EMAIL.phone_access_code }}</span></p>\n<p><span style=\"color: #48545d;\">Phone Type: {{ pwf.EMAIL.phone_type }}</span></p>\n<p><span style=\"color: #48545d;\">Phone Names: {{ pwf.EMAIL.phone_names }}</span></p>\n<p><span style=\"color: #48545d;\">Jabber Names: {{ pwf.EMAIL.jabber_names }}</span></p>\n<p><span style=\"color: #48545d;\">Extension Mobility Name: {{ pwf.EMAIL.extensionmobility_name }}</span></p>\n</td>\n</tr>\n<tr>\n<td height=\"20\"> </td>\n</tr>\n<tr>\n<td align=\"center\" valign=\"top\" width=\"48%\"><a style=\"display: block; padding: 15px 25px; background-color: #0c3c73; color: #ffffff; border-radius: 3px; text-decoration: none;\" href=\"https://www.voss-solutions.com/\">Voss Solutions</a></td>\n</tr>\n<tr>\n<td height=\"20\"> </td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>", "hierarchy_path": "sys" } } ] }
(Show the first instance)
{ "pkid": "655ed1d27667e9f1292dc074", "meta": { "tags": [ "V4UC", "ba_CommonOverlay" ], "cached": false, "title": "DR Activation", "business_key": { "hierarchy": true, "consider_null": false, "unique": [ "name" ] }, "schema_version": "2.2", "references": { "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "self": [ { "pkid": "655ed1d27667e9f1292dc074", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/" } ], "foreign_key": [], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/EmailHtmlTemplate/655ed1d27667e9f1292dc074/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/EmailHtmlTemplate", "path": [ "6t0ggef2c0deab00hb595101", "655ed1d27667e9f1292dc074" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "from": "[email protected]", "name": "DR Activation", "pkid": "655ed1d27667e9f1292dc075", "description": "DR Activation notification", "html_template": "<table id=\"main\" border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"0\" bgcolor=\"#F9F9F9\">\n<tbody>\n<tr>\n<td valign=\"top\">\n<table class=\"innermain\" style=\"margin: 0 auto; table-layout: fixed;\" border=\"0\" width=\"440\" cellspacing=\"0\" cellpadding=\"0\" align=\"center\" bgcolor=\"#F9F9F9\">\n<tbody>\n<tr>\n<td colspan=\"4\">\n<table style=\"box-shadow: 0 0 5px #E6E6E6; border: 1px solid #EFEFEF;\" border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"0\" bgcolor=\"#ffffff\">\n<tbody>\n<tr>\n<td height=\"20\"> </td>\n</tr>\n<tr>\n<td style=\"text-align: center;\" height=\"20\"> <img src=\"https://www.google.com/a/cpanel/voss-solutions.com/images/logo.gif?service=google_gsuite\" alt=\"Voss Solutions\" width=\"400\" height=\"135\" /></td>\n</tr>\n<tr style=\"font-family: Arial, Helvetica, sans-serif; color: #666666; font-size: 14px; line-height: 20px; margin-top: 20px;\">\n<td class=\"content\" style=\"padding-left: 40px; padding-right: 40px;\" colspan=\"2\" align=\"center\" valign=\"top\">\n<table border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"0\" bgcolor=\"#ffffff\">\n<tbody>\n<tr>\n<td height=\"30\"> </td>\n</tr>\n<tr>\n<td align=\"center\"><span style=\"color: #48545d; font-size: 22px; line-height: 24px;\"><span style=\"color: #48545d; font-size: 22px; line-height: 24px;\">Disaster Recovery Notice</span></span></td>\n</tr>\n<tr>\n<td height=\"30\"> </td>\n</tr>\n<tr>\n<td align=\"center\">\n<p><span style=\"color: #48545d; font-size: 14px; line-height: 24px;\">THIS IS A DR ACTIVATION NOTIFICATION EMAIL</span></p>\n<p><span style=\"color: #48545d; font-size: 14px; line-height: 24px;\">The following DR plan has been {{ pwf.EMAIL.status }}</span></p>\n<p><span style=\"color: #48545d; font-size: 14px; line-height: 24px;\">{{ pwf.EMAIL.plans }}</span></p>\n</td>\n</tr>\n<tr>\n<td height=\"20\"> </td>\n</tr>\n<tr>\n<td align=\"center\" valign=\"top\" width=\"48%\"><a style=\"display: block; padding: 15px 25px; background-color: #0c3c73; color: #ffffff; border-radius: 3px; text-decoration: none;\" href=\"https://www.voss-solutions.com/\">Voss Solutions</a></td>\n</tr>\n<tr>\n<td height=\"20\"> </td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>", "subject": "DR activation" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/EmailHtmlTemplate. | GET | /api/data/EmailHtmlTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/EmailHtmlTemplate as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/EmailHtmlTemplate/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/EmailHtmlTemplate/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/EmailHtmlTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/EmailHtmlTemplate/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/EmailHtmlTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/EmailHtmlTemplate/[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 data/EmailHtmlTemplate and the JSON format can be used to import instances of data/EmailHtmlTemplate.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/EmailHtmlTemplate/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/EmailHtmlTemplate/[pkid] | hierarchy=[hierarchy] | The data/EmailHtmlTemplate instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/EmailHtmlTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/EmailHtmlTemplate. |