跳转到内容

公告评论

评论是关于公告的通知形式，只能由技术人员添加。

属性

id （长整型）
公告评论的唯一标识符

id （长整型）
被视为具有较大值的数字位数。

示例 

234759602834500

评论 （html）
公告通知评论的内容

评论 （html）
HTML 是一个文本区域，可以使用 html 元素。

示例 

<b>The content to be displayed</b>

is_public （布尔型）
指示评论通知是否共享给请求者

is_public （布尔型）
布尔值，可以有两种可能的值。值为 true 和 false。

announcement （公告）
指示评论关联的公告

announcement （公告）
指示与公告通知评论相关联的公告

示例 

{
  "announcement": {
    "id": "100000000000052065",
    "title": "Bugs in AIX production server"
  }
}

parent_comment （公告评论）
表示当前回复的评论。

parent_comment （公告评论）
表示当前回复的评论。

示例 

{
  "parent_comment": {
    "comment": "This is notification comment",
    "id": "3304000001245275"
  }
}

created_by （用户）read only
指示创建通知评论的技术人员

created_by （用户）
指示创建通知评论的技术人员

示例 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

更多属性 全部展开

created_time （日期时间）read only

指示评论创建的时间

created_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

last_updated_time （日期时间）read only

表示评论/回复的最后修改时间。

last_updated_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

添加公告评论

此操作用于添加公告通知评论。

必填字段：- comment

Url

<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments

属性

id （长整型）
公告评论的唯一标识符

id （长整型）
被视为具有较大值的数字位数。

示例 

234759602834500

评论 （html）
公告通知评论的内容

评论 （html）
HTML 是一个文本区域，可以使用 html 元素。

示例 

<b>The content to be displayed</b>

is_public （布尔型）
指示评论通知是否共享给请求者

is_public （布尔型）
布尔值，可以有两种可能的值。值为 true 和 false。

announcement （公告）
指示评论关联的公告

announcement （公告）
指示与公告通知评论相关联的公告

示例 

{
  "announcement": {
    "id": "100000000000052065",
    "title": "Bugs in AIX production server"
  }
}

parent_comment （公告评论）
表示当前回复的评论。

parent_comment （公告评论）
表示当前回复的评论。

示例 

{
  "parent_comment": {
    "comment": "This is notification comment",
    "id": "3304000001245275"
  }
}

created_by （用户）read only
指示创建通知评论的技术人员

created_by （用户）
指示创建通知评论的技术人员

示例 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

更多属性 全部展开

created_time （日期时间）read only

指示评论创建的时间

created_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

last_updated_time （日期时间）read only

表示评论/回复的最后修改时间。

last_updated_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

$ curl <service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "announcement_comment": {
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\"><div>Test Private Notification comment<br></div></div>",
    "is_public": false
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "announcement_comment": {
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\"><div>Test Private Notification comment<br></div></div>",
    "is_public": false
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "announcement_comment": {
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\"><div>Test Private Notification comment<br></div></div>",
    "is_public": false
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "announcement_comment": {
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\"><div>Test Private Notification comment<br></div></div>",
    "is_public": false
  }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "announcement_comment": {
    "parent_comment": null,
    "created_time": {
      "display_value": "Nov 20, 2024 01:49 PM",
      "value": "1732090780394"
    },
    "last_updated_time": null,
    "is_public": false,
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div>Test Private Notification Comment<br></div></div>",
    "id": "100000000000052137",
    "created_by": {
      "email_id": "admin.mt@test.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "M",
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "cost_per_hour": "0",
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "100000000000006792",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "admin",
      "id": "100000000000040117",
      "photo_url": "https://contacts.zoho.com/file?exp=10&ID=15646919&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "admin",
      "job_title": null
    },
    "announcement": {
      "template": {
        "inactive": false,
        "name": "General Announcement Template",
        "id": "100000000000033852"
      },
      "attachments": [
        {
          "size": "388453",
          "content_type": "image/png",
          "file_id": "3005",
          "name": "testImage.png",
          "content_url": "/announcements/100000000000052059/_uploads/3005",
          "id": "100000000000052083"
        },
        {
          "size": "361693",
          "content_type": "image/png",
          "file_id": "3003",
          "name": "testPoster.png",
          "content_url": "/announcements/100000000000052059/_uploads/3003",
          "id": "100000000000052069"
        }
      ],
      "has_user_group": true,
      "show_to_requester": true,
      "show_to_all_technician": false,
      "description": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div class=\"personalize-wrapper\" style=\"font-family:&quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div><b>General Announcement</b> - <i>Description</i>&nbsp;&gt;&gt; 1<br></div></div><div><br></div></div>",
      "has_technician_group": false,
      "title": "General Announcement - Title >> 1",
      "access_level": "SHARED",
      "last_updated_by": {
        "email_id": "admin.mt@test.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "M",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006792",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "admin",
        "id": "100000000000040117",
        "photo_url": "https://contacts.zoho.com/file?exp=10&ID=15646919&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "admin",
        "job_title": null
      },
      "to_date": null,
      "last_updated_on": {
        "display_value": "Nov 20, 2024 01:49 PM",
        "value": "1732090780601"
      },
      "id": "100000000000052059",
      "announcement_type": {
        "name": "New Service Launched",
        "id": "100000000000034284"
      },
      "views_count": "1",
      "state": "ACTIVE",
      "technician_groups": [],
      "from_date": {
        "display_value": "Nov 20, 2024 11:51 AM",
        "value": "1732083706992"
      },
      "show_banner_until_expiry": true,
      "module": null,
      "is_followed": false,
      "isbannerenabled": true,
      "services": [
        {
          "image": "emp-onboarding",
          "inactive": false,
          "name": "Employee Onboarding",
          "description": "Requests related to new employee onboarding",
          "id": "100000000000040417",
          "sort_index": "0"
        },
        {
          "image": "fin-management",
          "inactive": false,
          "name": "Feature Request",
          "description": "Requests related to new features or improvements",
          "id": "100000000000040419",
          "sort_index": "0"
        }
      ],
      "priority": {
        "color": "#ff0000",
        "name": "High",
        "id": "100000000000006994"
      },
      "created_by": {
        "email_id": "admin.mt@test.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "M",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006792",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "admin",
        "id": "100000000000040117",
        "photo_url": "https://contacts.zoho.com/file?exp=10&ID=15646919&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "admin",
        "job_title": null
      },
      "deleted": false,
      "comments_count": "2",
      "created_date": {
        "display_value": "Nov 20, 2024 12:00 PM",
        "value": "1732084223469"
      },
      "to": ["admin.mt@test.com"],
      "banner_style": {
        "bgcolor": "#6dc5fa",
        "fontcolor": "#000000",
        "ispriority_based": false,
        "iconname": "emergency",
        "alignment": "left"
      },
      "user_groups": [
        {
          "name": "UG - 1",
          "id": "100000000000052003"
        },
        {
          "name": "UG - 2",
          "id": "100000000000052007"
        }
      ]
    }
  }
}

编辑公告评论

此操作用于更新公告评论。

Url

<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}

属性

id （长整型）
公告评论的唯一标识符

id （长整型）
被视为具有较大值的数字位数。

示例 

234759602834500

评论 （html）
公告通知评论的内容

评论 （html）
HTML 是一个文本区域，可以使用 html 元素。

示例 

<b>The content to be displayed</b>

is_public （布尔型）
指示评论通知是否共享给请求者

is_public （布尔型）
布尔值，可以有两种可能的值。值为 true 和 false。

announcement （公告）
指示评论关联的公告

announcement （公告）
指示与公告通知评论相关联的公告

示例 

{
  "announcement": {
    "id": "100000000000052065",
    "title": "Bugs in AIX production server"
  }
}

parent_comment （公告评论）
表示当前回复的评论。

parent_comment （公告评论）
表示当前回复的评论。

示例 

{
  "parent_comment": {
    "comment": "This is notification comment",
    "id": "3304000001245275"
  }
}

created_by （用户）read only
指示创建通知评论的技术人员

created_by （用户）
指示创建通知评论的技术人员

示例 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

更多属性 全部展开

created_time （日期时间）read only

指示评论创建的时间

created_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

last_updated_time （日期时间）read only

表示评论/回复的最后修改时间。

last_updated_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

$ curl <service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "announcement_comment": {
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div><i>Test</i> <b>Public</b> <u>Notification</u><br></div></div>",
    "is_public": true
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "announcement_comment": {
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div><i>Test</i> <b>Public</b> <u>Notification</u><br></div></div>",
    "is_public": true
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "announcement_comment": {
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div><i>Test</i> <b>Public</b> <u>Notification</u><br></div></div>",
    "is_public": true
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "announcement_comment": {
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div><i>Test</i> <b>Public</b> <u>Notification</u><br></div></div>",
    "is_public": true
  }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "announcement_comment": {
    "parent_comment": null,
    "created_time": {
      "display_value": "Nov 20, 2024 01:49 PM",
      "value": "1732090780394"
    },
    "last_updated_time": {
      "display_value": "Nov 20, 2024 01:51 PM",
      "value": "1732090903668"
    },
    "is_public": true,
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div><i>Test</i> <b>Public</b> <u>Notification</u><br></div></div>",
    "id": "100000000000052137",
    "created_by": {
      "email_id": "admin.mt@test.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "M",
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "cost_per_hour": "0",
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "100000000000006792",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "admin",
      "id": "100000000000040117",
      "photo_url": "https://contacts.zoho.com/file?exp=10&ID=15646919&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "admin",
      "job_title": null
    },
    "announcement": {
      "id": "100000000000052059",
      "title": "General Announcement - Title >> 1"
    }
  }
}

获取公告评论

此操作用于获取公告评论。

Url

<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}

属性

id （长整型）
公告评论的唯一标识符

id （长整型）
被视为具有较大值的数字位数。

示例 

234759602834500

评论 （html）
公告通知评论的内容

评论 （html）
HTML 是一个文本区域，可以使用 html 元素。

示例 

<b>The content to be displayed</b>

is_public （布尔型）
指示评论通知是否共享给请求者

is_public （布尔型）
布尔值，可以有两种可能的值。值为 true 和 false。

announcement （公告）
指示评论关联的公告

announcement （公告）
指示与公告通知评论相关联的公告

示例 

{
  "announcement": {
    "id": "100000000000052065",
    "title": "Bugs in AIX production server"
  }
}

parent_comment （公告评论）
表示当前回复的评论。

parent_comment （公告评论）
表示当前回复的评论。

示例 

{
  "parent_comment": {
    "comment": "This is notification comment",
    "id": "3304000001245275"
  }
}

created_by （用户）read only
指示创建通知评论的技术人员

created_by （用户）
指示创建通知评论的技术人员

示例 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

更多属性 全部展开

created_time （日期时间）read only

指示评论创建的时间

created_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

last_updated_time （日期时间）read only

表示评论/回复的最后修改时间。

last_updated_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "announcement_comment": {
    "parent_comment": null,
    "created_time": {
      "display_value": "Nov 20, 2024 01:49 PM",
      "value": "1732090780394"
    },
    "last_updated_time": {
      "display_value": "Nov 20, 2024 01:51 PM",
      "value": "1732090903668"
    },
    "is_public": true,
    "comment": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div><i>Test</i> <b>Public</b> <u>Notification</u><br></div></div>",
    "id": "100000000000052137",
    "created_by": {
      "email_id": "admin.mt@test.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "M",
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "cost_per_hour": "0",
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "100000000000006792",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "admin",
      "id": "100000000000040117",
      "photo_url": "https://contacts.zoho.com/file?exp=10&ID=15646919&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "admin",
      "job_title": null
    },
    "announcement": {
      "id": "100000000000052059",
      "title": "General Announcement - Title >> 1"
    }
  }
}

获取公告评论列表

此操作用于获取所有公告评论。

Url

<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments

属性

id （长整型）
公告评论的唯一标识符

id （长整型）
被视为具有较大值的数字位数。

示例 

234759602834500

评论 （html）
公告通知评论的内容

评论 （html）
HTML 是一个文本区域，可以使用 html 元素。

示例 

<b>The content to be displayed</b>

is_public （布尔型）
指示评论通知是否共享给请求者

is_public （布尔型）
布尔值，可以有两种可能的值。值为 true 和 false。

announcement （公告）
指示评论关联的公告

announcement （公告）
指示与公告通知评论相关联的公告

示例 

{
  "announcement": {
    "id": "100000000000052065",
    "title": "Bugs in AIX production server"
  }
}

parent_comment （公告评论）
表示当前回复的评论。

parent_comment （公告评论）
表示当前回复的评论。

示例 

{
  "parent_comment": {
    "comment": "This is notification comment",
    "id": "3304000001245275"
  }
}

created_by （用户）read only
指示创建通知评论的技术人员

created_by （用户）
指示创建通知评论的技术人员

示例 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

更多属性 全部展开

created_time （日期时间）read only

指示评论创建的时间

created_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

last_updated_time （日期时间）read only

表示评论/回复的最后修改时间。

last_updated_time （日期时间）
以 JSON 对象表示的日期/时间，包含 value 和 display_value 属性。

value ：时间的长格式（从 1970 年 1 月 1 日起的毫秒数）。

display_value ：以用户自定义格式显示的可读时间。如果未自定义，则使用默认格式。

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data='{
  "list_info": {
    "start_index": 1,
    "row_count": 50,
    "get_total_count": true,
    "filter_by": "thread_view"
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "list_info": {
    "start_index": 1,
    "row_count": 50,
    "get_total_count": true,
    "filter_by": "thread_view"
  }
};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{
  "list_info": {
    "start_index": 1,
    "row_count": 50,
    "get_total_count": true,
    "filter_by": "thread_view"
  }
}'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "list_info": {
    "start_index": 1,
    "row_count": 50,
    "get_total_count": true,
    "filter_by": "thread_view"
  }
}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "comments": [
    {
      "parent_comment": null,
      "created_time": {
        "display_value": "Nov 20, 2024 01:55 PM",
        "value": "1732091159409"
      },
      "last_updated_time": null,
      "is_public": false,
      "comment": "Test Private Notification - 2",
      "id": "100000000000052143",
      "created_by": {
        "email_id": "admin.mt@test.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "M",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006792",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "admin",
        "id": "100000000000040117",
        "photo_url": "https://contacts.zoho.com/file?exp=10&ID=15646919&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "admin",
        "job_title": null
      },
      "announcement": {
        "id": "100000000000052059",
        "title": "General Announcement - Title >> 1"
      }
    },
    {
      "parent_comment": null,
      "created_time": {
        "display_value": "Nov 20, 2024 01:49 PM",
        "value": "1732090780394"
      },
      "last_updated_time": {
        "display_value": "Nov 20, 2024 01:54 PM",
        "value": "1732091079931"
      },
      "is_public": true,
      "comment": "Test Public Notification - 1",
      "id": "100000000000052137",
      "created_by": {
        "email_id": "admin.mt@test.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "M",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006792",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "admin",
        "id": "100000000000040117",
        "photo_url": "https://contacts.zoho.com/file?exp=10&ID=15646919&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "admin",
        "job_title": null
      },
      "announcement": {
        "id": "100000000000052059",
        "title": "General Announcement - Title >> 1"
      }
    },
    {
      "parent_comment": {
        "id": "100000000000052137"
      },
      "created_time": {
        "display_value": "Nov 20, 2024 01:54 PM",
        "value": "1732091064396"
      },
      "last_updated_time": {
        "display_value": "Nov 20, 2024 01:55 PM",
        "value": "1732091139116"
      },
      "is_public": true,
      "comment": "Test Public Reply Notifcation to Comment - 1",
      "id": "100000000000052139",
      "created_by": {
        "email_id": "admin.mt@test.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "M",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006792",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "admin",
        "id": "100000000000040117",
        "photo_url": "https://contacts.zoho.com/file?exp=10&ID=15646919&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "admin",
        "job_title": null
      },
      "announcement": {
        "id": "100000000000052059",
        "title": "General Announcement - Title >> 1"
      }
    },
    {
      "parent_comment": {
        "id": "100000000000052137"
      },
      "created_time": {
        "display_value": "Nov 20, 2024 01:55 PM",
        "value": "1732091125967"
      },
      "last_updated_time": null,
      "is_public": false,
      "comment": "Test Private Reply Notification to Comment - 1",
      "id": "100000000000052141",
      "created_by": {
        "email_id": "admin.mt@test.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "M",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006792",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "admin",
        "id": "100000000000040117",
        "photo_url": "https://contacts.zoho.com/file?exp=10&ID=15646919&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "admin",
        "job_title": null
      },
      "announcement": {
        "id": "100000000000052059",
        "title": "General Announcement - Title >> 1"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "start_index": 1,
    "total_count": 4,
    "filter_by": "thread_view",
    "page": 1,
    "get_total_count": "true",
    "row_count": 4
  }
}

删除公告评论

此操作用于删除公告评论。

Url

<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}


$ curl <service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/announcements/{announcement_id}/comments/{comment_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}