Retrieve detailed information about a specific announcement

Get the individual Announcement details

Endpoints

get /api/v1/mdm/announcements/{announcement_id}

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/announcements/{announcement_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

announcement_idstringMandatory

Unique identifier of the announcement. Obtain from the Create Announcement or Get Announcements response

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/api/v1/mdm/announcements/{announcement_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/announcements/{announcement_id}"))
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = {
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/api/v1/mdm/announcements/{announcement_id}", headers=headers)

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

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


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/announcements/{announcement_id}"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/announcements/{announcement_id}' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

announcement_idlong

Unique ID representing the announcement

announcement_namestring

Name/title of the announcement

announcement_formatinteger

Display format code for the announcement

creation_timestring

Epoch timestamp (milliseconds) when the announcement was created

last_modified_timestring

Epoch timestamp (milliseconds) when the announcement was last modified

created_by_userstring

Username of the admin who created the announcement

last_modified_by_userstring

Username of the admin who last modified the announcement

collection_idstring

Internal collection ID associated with this announcement

profile_idstring

Internal profile ID associated with this announcement

ack_buttonstring

Acknowledgement button text shown on device. Empty string if acknowledgement not required

needs_acknowledgementboolean

Whether the announcement requires acknowledgement from the device user

is_moved_to_trashboolean

Whether the announcement has been soft-deleted

no_of_devices_distributedstring

Number of devices the announcement is distributed to

no_of_groups_distributedstring

Number of groups the announcement is distributed to

announcement_detailJSON Object

Nested object containing full announcement message content details including acknowledgement settings

Show Sub-Attributes

titlestring

Title of the announcement

title_colorstring

Hex color code for the title text (e.g., #ffffff)

nbar_iconstring

Path to the notification bar icon image

nbar_messagestring

Short message displayed in the device notification bar

detail_messagestring

Full HTML message content displayed in the app

announcement_img_idstring

Image ID for the notification bar image

needs_acknowledgementstring

Whether acknowledgement is required from the device user

ack_buttonstring

Acknowledgement button text shown on the device

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Announcement details with distribution counts

Copied!

  {
    "creation_time": "1603910052300",
    "last_modified_time": "1603910052252",
    "announcement_name": "test1",
    "announcement_format": 1,
    "needs_acknowledgement": false,
    "last_modified_by_user": "admin",
    "no_of_devices_distributed": "0",
    "created_by_user": "admin",
    "no_of_groups_distributed": "0",
    "collection_id": "9007199254741137",
    "ack_button": "",
    "is_moved_to_trash": false,
    "profile_id": "9007199254740995",
    "announcement_id": 9007199254740996,
    "announcement_detail": {
      "ack_button": "",
      "nbar_message": "",
      "title_color": "#ffffff",
      "nbar_icon": "/images/announcement/nbaricon/info.png",
      "announcement_img_id": "9007199254740995",
      "needs_acknowledgement": "false",
      "detail_message": "Sample announcement content",
      "title": "test1"
    }
  }

▼ Show full

Announcement with acknowledgement enabled and active distribution

Copied!

  {
    "creation_time": "1679500000000",
    "last_modified_time": "1679600000000",
    "announcement_name": "Policy Update",
    "announcement_format": 1,
    "needs_acknowledgement": true,
    "last_modified_by_user": "admin",
    "no_of_devices_distributed": "15",
    "created_by_user": "admin",
    "no_of_groups_distributed": "3",
    "collection_id": "9007199254741200",
    "ack_button": "Got It",
    "is_moved_to_trash": false,
    "profile_id": "9007199254740996",
    "announcement_id": 9007199254740996,
    "announcement_detail": {
      "ack_button": "Got It",
      "nbar_message": "Important policy update",
      "title_color": "#ff5722",
      "nbar_icon": "/images/announcement/nbaricon/info.png",
      "announcement_img_id": "9007199254740996",
      "needs_acknowledgement": "true",
      "detail_message": "<p>Please review the updated company policy</p>",
      "title": "Policy Update"
    }
  }

▼ Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.