Creates and deploys a new announcement to targeted computers or users

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

Creates and deploys a new announcement with the specified message, schedule window (start time, end time, lap time), platform, and target computers or groups. Accepts a JSON body with the full announcement collection configuration.

Request URL

https://{server-hostname}:8383/dcapi/tools/announcement/deploy

Scope

Tools.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/announcementDeployStatus.v1+jsonapplication/announcementDeployStatus.v1+jsonCopied!
Content-TypestringMandatory
application/announcementCollectionDetails.v1+jsonapplication/announcementCollectionDetails.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
labelstringMandatory
deployActionstringOptional
isModifybooleanOptional
isImageAnnouncementbooleanOptional
imageIDsJSON ArrayOptional
Show Sub-Attributes
string
deleteImagesJSON ArrayOptional
Show Sub-Attributes
string
collectionIDstringOptional

RoleId. Get Role Id

targetDetailsJSON ObjectOptional
Show Sub-Attributes
targetTypestringOptional
targetValuestringOptional
envTypestringOptional
configDetailsJSON ArrayOptional
Show Sub-Attributes
JSON Object
Show Sub-Attributes
configNamestringMandatory
configTypestringOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/dcapi/tools/announcement/deploy \
  --header 'Accept: application/announcementDeployStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/announcementCollectionDetails.v1+json' \
  --data '{"deployAction":"Deploy","configDetails":[{"toolDetails":{"repeatFrequency":1,"repeatDuration":600,"startTime":"22:00","endTime":"02:00","message":"System maintenance tonight from 11 PM to 2 AM."}}],"label":"Maintenance Window Notice","isModify":false,"configType":"Computer","collectionID":0,"targetDetails":{"envType":0,"targetValue":"Engineering","targetType":"CustomGroup"}}'

Sample Request Body

Copied!
  {
    "deployAction": "Deploy",
    "configDetails": [
      {
        "toolDetails": {
          "repeatFrequency": 1,
          "repeatDuration": 600,
          "startTime": "22:00",
          "endTime": "02:00",
          "message": "System maintenance tonight from 11 PM to 2 AM."
        }
      }
    ],
    "label": "Maintenance Window Notice",
    "isModify": false,
    "configType": "Computer",
    "collectionID": 0,
    "targetDetails": {
      "envType": 0,
      "targetValue": "Engineering",
      "targetType": "CustomGroup"
    }
  }
                
Show full

Response Parameters

- HTTP code 200

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

Result of the create or update operation: success or failure

collectionIdlong

Unique identifier of the created or updated task collection

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "collectionId": 7,
    "status": "success"
  }
                
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.