Announcement
Announcement
Attribute
[
{
"announcement_name": "Test announcement",
"announcement_format": 1,
"creation_time": 1603910052300,
"created_by_user": "admin",
"last_modified_time": 1603910052252,
"collection_id": 9007199254741136,
"profile_id": 9007199254740996,
"last_modified_by_user": "admin",
"ack_button": "Got It",
"announcement_id": 9007199254740996,
"is_moved_to_trash": false,
"needs_acknowledgement": true,
"announcement_detail": {
"title_color": "#123123",
"title": "Test announcement",
"nbar_icon": "/images/announcement/nbaricon/info.png",
"detail_message": "<p>Test announcement</p>",
"nbar_message": "Test message",
"needs_acknowledgement": true,
"ack_button": "Got It"
}
}
]
Get All Announcements
Fetches all the announcements that have been created.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET - /api/v1/mdm/announcements
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/api/v1/mdm/announcements", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
curl --request GET \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
HTTP/1.1 200 OK{
"announcement": [
{
"announcement_name": "Test announcement",
"announcement_format": 1,
"creation_time": 1603910052300,
"created_by_user": "admin",
"last_modified_time": 1603910052252,
"collection_id": 9007199254741136,
"profile_id": 9007199254740996,
"last_modified_by_user": "admin",
"ack_button": "Got It",
"announcement_id": 9007199254740996,
"is_moved_to_trash": false,
"needs_acknowledgement": true,
"announcement_detail": {
"title_color": "#123123",
"title": "Test announcement",
"nbar_icon": "/images/announcement/nbaricon/info.png",
"detail_message": "<p>Test announcement</p>",
"nbar_message": "Test message",
"needs_acknowledgement": true,
"ack_button": "Got It"
}
}
]
}
Create an announcement
Creates a new announcement.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST - /api/v1/mdm/announcements
Arguments
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/api/v1/mdm/announcements", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
curl --request POST \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"announcement_name": "Test announcement",
"announcement_format": 1,
"announcement_detail": {
"title_color": "#123123",
"title": "Test announcement",
"nbar_icon": "/images/announcement/nbaricon/info.png",
"detail_message": "<p>Test announcement</p>",
"nbar_message": "Test message",
"needs_acknowledgement": true,
"ack_button": "Got It"
}
}
HTTP/1.1 204 No Content
Delete the Announcements
Deletes an announcement for given announcement IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE - /api/v1/mdm/announcements
Arguments
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("DELETE", "/api/v1/mdm/announcements", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements")
.delete(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
curl --request DELETE \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"announcement_id": 9007199254740996
}
HTTP/1.1 204 No Content
Get Announcement details
Fetches the details of an announcement for a given announcement ID.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET - /api/v1/mdm/announcements/{announcement_id}
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/api/v1/mdm/announcements/9007199254740996", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
curl --request GET \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996 \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
HTTP/1.1 200 OK{
"creation_time": 1603910052300,
"last_modified_time": 1603910052252,
"announcement_name": "Test announcement",
"announcement_format": 1,
"needs_acknowledgement": true,
"last_modified_by_user": "admin",
"no_of_devices_distributed": 0,
"created_by_user": "admin",
"no_of_groups_distributed": 0,
"collection_id": 9007199254741136,
"ack_button": "Got It",
"is_moved_to_trash": false,
"profile_id": 9007199254740996,
"announcement_id": 9007199254740996,
"announcement_detail": {
"title_color": "#123123",
"title": "Test announcement",
"nbar_icon": "/images/announcement/nbaricon/info.png",
"detail_message": "<p>Test announcement</p>",
"nbar_message": "Test message",
"needs_acknowledgement": true,
"ack_button": "Got It"
}
}
Modify Announcement
Modifies an existing announcementoauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT - /api/v1/mdm/announcements/{announcement_id}
Arguments
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/api/v1/mdm/announcements/9007199254740996", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
curl --request PUT \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996 \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"announcement_name": "Test announcement",
"announcement_format": 1,
"announcement_detail": {
"title_color": "#123123",
"title": "Test announcement",
"nbar_icon": "/images/announcement/nbaricon/info.png",
"detail_message": "<p>Test announcement</p>",
"nbar_message": "Test message",
"needs_acknowledgement": true,
"ack_button": "Got It"
}
}
HTTP/1.1 204 No Content
Delete Announcement
Deletes an announcement for a specific announcement ID.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE - /api/v1/mdm/announcements/{announcement_id}
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/api/v1/mdm/announcements/9007199254740996", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
curl --request DELETE \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996 \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
HTTP/1.1 204 No Content
Get Announcement distribution to group details
Fetches the Group IDs to which the announcement is distributed.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET - /api/v1/mdm/announcements/{announcement_id}/groups
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/api/v1/mdm/announcements/9007199254740996/groups", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/groups")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
curl --request GET \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/groups \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
HTTP/1.1 200 OK{
"groups": [
"1",
"2",
"3"
]
}
Distribute Announcement to groups
Distributes an announcement to given group IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST - /api/v1/mdm/announcements/{announcement_id}/groups
Arguments
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/api/v1/mdm/announcements/9007199254740996/groups", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/groups")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
curl --request POST \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/groups \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"group_ids": [
"1",
"2",
"3"
]
}
HTTP/1.1 204 No Content
Remove announcement from group
Disassociates the announcement from the given group IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE - /api/v1/mdm/announcements/{announcement_id}/groups
Arguments
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("DELETE", "/api/v1/mdm/announcements/9007199254740996/groups", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/groups")
.delete(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
curl --request DELETE \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/groups \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"group_ids": [
"1",
"2",
"3"
]
}
HTTP/1.1 204 No Content
Distribute announcement to devices
Distributes an announcement to the given device IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST - /api/v1/mdm/announcements/{announcement_id}/devices
Arguments
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/api/v1/mdm/announcements/9007199254740996/devices", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/devices")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
curl --request POST \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/devices \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"device_ids": [
"1",
"2",
"3"
]
}
HTTP/1.1 204 No Content
Remove announcement from devices
Disassociates the announcement from the given device IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE - /api/v1/mdm/announcements/{announcement_id}/devices
Arguments
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("DELETE", "/api/v1/mdm/announcements/9007199254740996/devices", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/devices")
.delete(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
curl --request DELETE \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/devices \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"device_ids": [
"1",
"2",
"3"
]
}
HTTP/1.1 204 No Content
Get Announcement distribution to device details
Fetches the device IDs to which the announcement is distributed.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET - /api/v1/mdm/announcements/{announcement_id}/device
import http.client
conn = http.client.HTTPSConnection("www.mdm.manageengine.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/api/v1/mdm/announcements/9007199254740996/device", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/device")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
curl --request GET \
--url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/device \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
HTTP/1.1 200 OK{
"devices": [
"1",
"2",
"3"
]
}