TCL / Support API / Getting Comments
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/requests/:request_id/comments/:ticket_comment_id" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "comment": {
# "attachments": [
# {
# "content_type": "<string>",
# "content_url": "<string>",
# "deleted": "<boolean>",
# "file_name": "<string>",
# "height": "<string>",
# "id": "<integer>",
# "inline": "<boolean>",
# "malware_access_override": "<boolean>",
# "malware_scan_result": "<string>",
# "mapped_content_url": "<string>",
# "size": "<integer>",
# "url": "<string>",
# "width": "<string>",
# "thumbnails": [
# {
# "content_type": "<string>",
# "content_url": "<string>",
# "deleted": "<boolean>",
# "file_name": "<string>",
# "height": "<string>",
# "id": "<integer>",
# "inline": "<boolean>",
# "malware_access_override": "<boolean>",
# "malware_scan_result": "<string>",
# "mapped_content_url": "<string>",
# "size": "<integer>",
# "url": "<string>",
# "width": "<string>"
# },
# {
# "content_type": "<string>",
# "content_url": "<string>",
# "deleted": "<boolean>",
# "file_name": "<string>",
# "height": "<string>",
# "id": "<integer>",
# "inline": "<boolean>",
# "malware_access_override": "<boolean>",
# "malware_scan_result": "<string>",
# "mapped_content_url": "<string>",
# "size": "<integer>",
# "url": "<string>",
# "width": "<string>"
# }
# ]
# },
# {
# "content_type": "<string>",
# "content_url": "<string>",
# "deleted": "<boolean>",
# "file_name": "<string>",
# "height": "<string>",
# "id": "<integer>",
# "inline": "<boolean>",
# "malware_access_override": "<boolean>",
# "malware_scan_result": "<string>",
# "mapped_content_url": "<string>",
# "size": "<integer>",
# "url": "<string>",
# "width": "<string>",
# "thumbnails": [
# {
# "content_type": "<string>",
# "content_url": "<string>",
# "deleted": "<boolean>",
# "file_name": "<string>",
# "height": "<string>",
# "id": "<integer>",
# "inline": "<boolean>",
# "malware_access_override": "<boolean>",
# "malware_scan_result": "<string>",
# "mapped_content_url": "<string>",
# "size": "<integer>",
# "url": "<string>",
# "width": "<string>"
# },
# {
# "content_type": "<string>",
# "content_url": "<string>",
# "deleted": "<boolean>",
# "file_name": "<string>",
# "height": "<string>",
# "id": "<integer>",
# "inline": "<boolean>",
# "malware_access_override": "<boolean>",
# "malware_scan_result": "<string>",
# "mapped_content_url": "<string>",
# "size": "<integer>",
# "url": "<string>",
# "width": "<string>"
# }
# ]
# }
# ],
# "audit_id": "<integer>",
# "author_id": "<integer>",
# "body": "<string>",
# "created_at": "<dateTime>",
# "html_body": "<string>",
# "id": "<integer>",
# "metadata": {
# "aliquipf9_": 29396975.17451787
# },
# "plain_body": "<string>",
# "public": "<boolean>",
# "type": "<string>",
# "uploads": [
# "<string>",
# "<string>"
# ],
# "via": {
# "channel": "<string>",
# "source": {
# "mollit8": -84219258
# }
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Audit_id [CkJsonObject_stringOf $jResp "comment.audit_id"]
set Author_id [CkJsonObject_stringOf $jResp "comment.author_id"]
set Body [CkJsonObject_stringOf $jResp "comment.body"]
set Created_at [CkJsonObject_stringOf $jResp "comment.created_at"]
set Html_body [CkJsonObject_stringOf $jResp "comment.html_body"]
set Id [CkJsonObject_stringOf $jResp "comment.id"]
set Aliquipf9_ [CkJsonObject_stringOf $jResp "comment.metadata.aliquipf9_"]
set Plain_body [CkJsonObject_stringOf $jResp "comment.plain_body"]
set v_Public [CkJsonObject_stringOf $jResp "comment.public"]
set v_Type [CkJsonObject_stringOf $jResp "comment.type"]
set Channel [CkJsonObject_stringOf $jResp "comment.via.channel"]
set Mollit8 [CkJsonObject_IntOf $jResp "comment.via.source.mollit8"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "comment.attachments"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set content_type [CkJsonObject_stringOf $jResp "comment.attachments[i].content_type"]
set content_url [CkJsonObject_stringOf $jResp "comment.attachments[i].content_url"]
set deleted [CkJsonObject_stringOf $jResp "comment.attachments[i].deleted"]
set file_name [CkJsonObject_stringOf $jResp "comment.attachments[i].file_name"]
set height [CkJsonObject_stringOf $jResp "comment.attachments[i].height"]
set id [CkJsonObject_stringOf $jResp "comment.attachments[i].id"]
set inline [CkJsonObject_stringOf $jResp "comment.attachments[i].inline"]
set malware_access_override [CkJsonObject_stringOf $jResp "comment.attachments[i].malware_access_override"]
set malware_scan_result [CkJsonObject_stringOf $jResp "comment.attachments[i].malware_scan_result"]
set mapped_content_url [CkJsonObject_stringOf $jResp "comment.attachments[i].mapped_content_url"]
set size [CkJsonObject_stringOf $jResp "comment.attachments[i].size"]
set url [CkJsonObject_stringOf $jResp "comment.attachments[i].url"]
set width [CkJsonObject_stringOf $jResp "comment.attachments[i].width"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "comment.attachments[i].thumbnails"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set content_type [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].content_type"]
set content_url [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].content_url"]
set deleted [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].deleted"]
set file_name [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].file_name"]
set height [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].height"]
set id [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].id"]
set inline [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].inline"]
set malware_access_override [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].malware_access_override"]
set malware_scan_result [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].malware_scan_result"]
set mapped_content_url [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].mapped_content_url"]
set size [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].size"]
set url [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].url"]
set width [CkJsonObject_stringOf $jResp "comment.attachments[i].thumbnails[j].width"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "comment.uploads"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "comment.uploads[i]"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests/:request_id/comments/:ticket_comment_id
Postman Collection Item JSON
{
"name": "Getting Comments",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests/:request_id/comments/:ticket_comment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
":request_id",
"comments",
":ticket_comment_id"
],
"variable": [
{
"key": "request_id",
"value": "<integer>"
},
{
"key": "ticket_comment_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n\n* End Users\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests/:request_id/comments/:ticket_comment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
":request_id",
"comments",
":ticket_comment_id"
],
"variable": [
{
"key": "request_id"
},
{
"key": "ticket_comment_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"comment\": {\n \"attachments\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n }\n ],\n \"audit_id\": \"<integer>\",\n \"author_id\": \"<integer>\",\n \"body\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"html_body\": \"<string>\",\n \"id\": \"<integer>\",\n \"metadata\": {\n \"aliquipf9_\": 29396975.17451787\n },\n \"plain_body\": \"<string>\",\n \"public\": \"<boolean>\",\n \"type\": \"<string>\",\n \"uploads\": [\n \"<string>\",\n \"<string>\"\n ],\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"mollit8\": -84219258\n }\n }\n }\n}"
}
]
}
