Notification Meta

Meta APIs Notification in ID360

Download Notification Meta OpenAPI Document

End Points

/meta/templates/notification/default_configs

/meta/templates/notification/module_configs

Get Notification Default Configs

The Get Notification Default Configs API can be used to get the default configurations for notification templates.
OAuth Scope : id360.meta.READ

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/meta/templates/notification/default_configs"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/meta/templates/notification/default_configs")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/meta/templates/notification/default_configs', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/api/v1/meta/templates/notification/default_configs", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/meta/templates/notification/default_configs",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/meta/templates/notification/default_configs \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": {
        "modes": [
            {
                "server_value": "Email",
                "client_value": "Email"
            },
            {
                "server_value": "SMS",
                "client_value": "SMS"
            },
            {
                "server_value": "Email_and_SMS",
                "client_value": "Email and SMS"
            }
        ],
        "modules": [
            {
                "server_value": "Reports",
                "client_value": "Reports"
            },
            {
                "server_value": "Orchestration",
                "client_value": "Orchestration"
            }
        ],
        "mail_severity": [
            {
                "server_value": "Low",
                "client_value": "Low"
            },
            {
                "server_value": "Medium",
                "client_value": "Medium"
            },
            {
                "server_value": "High",
                "client_value": "High"
            }
        ],
        "mail_rcpt_macros_list": {
            "orchestration": [
                {
                    "server_value": "SELF",
                    "client_value": "Self",
                    "macro_type": "defaultType",
                    "is_mandatory": false
                },
                {
                    "server_value": "Manager",
                    "client_value": "Manager",
                    "macro_type": "defaultType",
                    "is_mandatory": false
                }
            ],
            "reports": [
                {
                    "server_value": "SELF",
                    "client_value": "Self",
                    "macro_type": "defaultType",
                    "is_mandatory": false
                }
            ]
        },
        "sms_rcpt_macros_list": {
            "orchestration": [
                {
                    "server_value": "SELF",
                    "client_value": "Self",
                    "macro_type": "defaultType",
                    "is_mandatory": false
                },
                {
                    "server_value": "Manager",
                    "client_value": "Manager",
                    "macro_type": "defaultType",
                    "is_mandatory": false
                }
            ],
            "reports": [
                {
                    "server_value": "SELF",
                    "client_value": "Self",
                    "macro_type": "defaultType",
                    "is_mandatory": false
                }
            ]
        },
        "attachment_formats": [
            {
                "server_value": "PDF",
                "client_value": "PDF"
            }
        ],
        "editor_options": [
            "rtEditor",
            "plainText"
        ],
        "max_mail_content_size": 2,
        "max_sms_content_size": 3,
        "max_template_name_size": 4,
        "template_name_regex": "^[a-zA-Z0-9_ ]{1,50}$",
        "max_template_desc_size": 7,
        "hide_add_remove_column": true,
        "sorted_col_icon_only": true,
        "max_to_cc_size": 556,
        "max_sms_number_count": 45
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Get Notification Module Configs

The Get Notification Module Configs API can be used to get the notification module configurations.
OAuth Scope : id360.meta.READ

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/meta/templates/notification/module_configs"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/meta/templates/notification/module_configs")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/meta/templates/notification/module_configs', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/api/v1/meta/templates/notification/module_configs", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/meta/templates/notification/module_configs",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/meta/templates/notification/module_configs \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": {
        "file_upload_extension": "7Z,ARJ,RAR",
        "default_mail_content": "<div>Dear user, <br></div><div><br></div><div>Your requested report, %report_name%, having been generated on %date% is now ready for download.</div>",
        "default_sms_content": "sms content",
        "content_macros": [
            {
                "server_value": "date",
                "client_value": "idmpod.notification_template.macro.date",
                "is_mandatory": false
            }
        ],
        "show_priority": true,
        "default_mail_subject": "Report Export Notification",
        "show_mail_rcpt_macros_list": true,
        "show_sms_rcpt_macros_list": true,
        "show_module_sms_content_macros": true,
        "is_sms_content_disabled": true,
        "is_html_wrap_needed": true,
        "html_wrap": "<div>{{body}}</div>",
        "show_editor_modes": true
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}