[Index]
This model stores SMTP server connection parameters.
Model ref.: data/Email
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": {
"username": {
"required": false,
"type": "string",
"description": "Username to use when authenticating for sending email messages.",
"title": "Username"
},
"secure": {
"type": "boolean",
"description": "Uses secure connection.",
"title": "Secure"
},
"description": {
"type": "string",
"description": "Description of the Email account.",
"title": "Description"
},
"host": {
"required": true,
"type": "string",
"description": "Hostname of the SMTP server.",
"title": "Hostname"
},
"password": {
"is_password": true,
"description": "Password to use when authenticating for sending email messages.",
"title": "Password",
"required": false,
"store_encrypted": true,
"type": "string"
},
"port": {
"default": "587",
"required": true,
"type": "string",
"description": "Port of the SMTP server.",
"title": "Port"
},
"name": {
"required": true,
"type": "string",
"description": "Name for this STMP server.",
"title": "Name"
}
},
"schema_version": "2.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/Email/add/ |
|
The GUI Add form of data/Email 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/Email/ | 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/Email/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Email/[pkid1]", "/api/data/Email/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Email/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Email; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Email/export/ |
|
{ "hrefs":["/api/data/Email/[pkid1]", "/api/data/Email/[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/Email and the JSON format can be used to import instances of data/Email.
GET http://[host-proxy]/api/data/Email/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/Email | POST | /api/data/Email/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/Email/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/Email/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/Email/ |
|
The data/Email schema and all instances as JSON. |
(The list will return 0 to 3 data/Email 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/Email/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"consider_null": false,
"unique": [
"name"
]
},
"schema_version": "2.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/data/Email/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Email/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Email/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/Email/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Email/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/Email/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/Email/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/Email/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Email/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Email",
"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"
},
{
"name": "host",
"title": "Hostname"
},
{
"name": "port",
"title": "Port"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "61b19fb2eadb826afd86f964",
"meta": {
"tags": [],
"cached": true,
"title": "SMTPEmailQAS",
"business_key": {
"hierarchy": true,
"consider_null": false,
"unique": [
"name"
]
},
"schema_version": "2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "61b19fb2eadb826afd86f964",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/"
}
],
"parent": [
{
"pkid": "61b12ed1eadb826afd7b6ddc",
"href": "/api/data/HierarchyNode/61b12ed1eadb826afd7b6ddc"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Email",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b19fb2eadb826afd86f964"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Hostname"
},
{
"name": "port",
"title": "Port"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "SMTPEmailQAS",
"pkid": "61b19fb2eadb826afd86f965",
"description": "this SMTP is for testing automatic emails being sent after a succesfull QAS operation if the option is enabled. It has all the correct information",
"host": "172.29.42.30",
"hierarchy_friendly_name": "CS-NB (Reseller)",
"port": "587",
"hierarchy_path": "sys.hcs.CS-P.CS-NB"
}
}
]
}
(Show the first instance)
{
"pkid": "61b19fb2eadb826afd86f964",
"meta": {
"tags": [],
"cached": false,
"title": "SMTPEmailQAS",
"business_key": {
"hierarchy": true,
"consider_null": false,
"unique": [
"name"
]
},
"schema_version": "2.0",
"references": {
"parent": [
{
"pkid": "61b12ed1eadb826afd7b6ddc",
"href": "/api/data/HierarchyNode/61b12ed1eadb826afd7b6ddc"
}
],
"self": [
{
"pkid": "61b19fb2eadb826afd86f964",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Email/61b19fb2eadb826afd86f964/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Email",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b19fb2eadb826afd86f964"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Hostname"
},
{
"name": "port",
"title": "Port"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"pkid": "61b19fb2eadb826afd86f965",
"host": "172.29.42.30",
"port": "587",
"name": "SMTPEmailQAS",
"description": "this SMTP is for testing automatic emails being sent after a succesfull QAS operation if the option is enabled. It has all the correct information"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/Email. | GET | /api/data/Email/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Email as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/Email/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/Email/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/Email/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/Email/?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/Email; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/Email/[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/Email and the JSON format can be used to import instances of data/Email.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/Email/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/Email/[pkid]/ | hierarchy=[hierarchy] | The data/Email instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/Email/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Email. |