Retrieves the complete configuration details of the specified announcement

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the full configuration details of the specified announcement, including the message content, schedule (start time, end time, lap time), deployment targets, and current status.

Request URL

https://{serverurl}/dcapi/tools/announcement/{collectionId}

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

collectionIdstringMandatory

The unique identifier of the system tools collection

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/tools/announcement/{collectionId} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
collectionIdlong

Announcement collection unique identifier

labelstring

Announcement display label

statusstring

Deployment status

configTypestring

Target scope: Computer or User

targetDetailsJSON Object

Target configuration with targetType, targetValue, and envType

Show Sub-Attributes
configDetailsarray

Array containing announcement toolDetails with message, schedule, and timing

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "configDetails": [
      {
        "toolDetails": {
          "repeatFrequency": 1,
          "repeatDuration": 600,
          "startTime": "22:00",
          "endTime": "02:00",
          "message": "System maintenance scheduled tonight from 11 PM to 2 AM."
        }
      }
    ],
    "label": "Maintenance Window Notice",
    "configType": "Computer",
    "collectionId": 7,
    "targetDetails": {
      "envType": 0,
      "targetValue": "Engineering",
      "targetType": "CustomGroup"
    },
    "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.