Retrieves a summary overview of the specified announcement Returns the summary overview of the specified announcement collection, including the message text, deployment status, target count, and schedule window.
Request URL https://{server-hostname}:8383/dcapi/tools/announcement/{collectionId}/details
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers - Path Parameters collectionId string Mandatory
The unique identifier of the system tools collection
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/announcement/{collectionId}/details \
--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/dcapi/tools/announcement/{collectionId}/details"))
.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", "/dcapi/tools/announcement/{collectionId}/details", 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/dcapi/tools/announcement/{collectionId}/details"
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/dcapi/tools/announcement/{collectionId}/details' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes collectionId long
Announcement collection unique identifier
label string
Announcement display label
status string
Deployment status: Active, Suspended, Completed
targetCount integer
Number of target computers or users
startTime long
Scheduled start time (epoch)
endTime long
Scheduled end time (epoch)
messageSummary string
Truncated announcement message preview
Possible Response Codes Sample Response: HTTP 200 {
"messageSummary": "System maintenance scheduled tonight.",
"startTime": 1711400000000,
"label": "Maintenance Window Notice",
"endTime": 1711436000000,
"collectionId": 7,
"targetCount": 40,
"status": "Active"
}
▼ Show full
Duration: 1 minute | Threshold: 30 | 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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.