Chilkat Online Tools

Powershell / Support API / Getting Comments

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"

$http.SetRequestHeader("Accept","application/json")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/requests/:request_id/comments/:ticket_comment_id",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    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

$Audit_id = $jResp.StringOf("comment.audit_id")
$Author_id = $jResp.StringOf("comment.author_id")
$Body = $jResp.StringOf("comment.body")
$Created_at = $jResp.StringOf("comment.created_at")
$Html_body = $jResp.StringOf("comment.html_body")
$Id = $jResp.StringOf("comment.id")
$Aliquipf9_ = $jResp.StringOf("comment.metadata.aliquipf9_")
$Plain_body = $jResp.StringOf("comment.plain_body")
$v_Public = $jResp.StringOf("comment.public")
$v_Type = $jResp.StringOf("comment.type")
$Channel = $jResp.StringOf("comment.via.channel")
$Mollit8 = $jResp.IntOf("comment.via.source.mollit8")
$i = 0
$count_i = $jResp.SizeOfArray("comment.attachments")
while ($i -lt $count_i) {
    $jResp.I = $i
    $content_type = $jResp.StringOf("comment.attachments[i].content_type")
    $content_url = $jResp.StringOf("comment.attachments[i].content_url")
    $deleted = $jResp.StringOf("comment.attachments[i].deleted")
    $file_name = $jResp.StringOf("comment.attachments[i].file_name")
    $height = $jResp.StringOf("comment.attachments[i].height")
    $id = $jResp.StringOf("comment.attachments[i].id")
    $inline = $jResp.StringOf("comment.attachments[i].inline")
    $malware_access_override = $jResp.StringOf("comment.attachments[i].malware_access_override")
    $malware_scan_result = $jResp.StringOf("comment.attachments[i].malware_scan_result")
    $mapped_content_url = $jResp.StringOf("comment.attachments[i].mapped_content_url")
    $size = $jResp.StringOf("comment.attachments[i].size")
    $url = $jResp.StringOf("comment.attachments[i].url")
    $width = $jResp.StringOf("comment.attachments[i].width")
    $j = 0
    $count_j = $jResp.SizeOfArray("comment.attachments[i].thumbnails")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $content_type = $jResp.StringOf("comment.attachments[i].thumbnails[j].content_type")
        $content_url = $jResp.StringOf("comment.attachments[i].thumbnails[j].content_url")
        $deleted = $jResp.StringOf("comment.attachments[i].thumbnails[j].deleted")
        $file_name = $jResp.StringOf("comment.attachments[i].thumbnails[j].file_name")
        $height = $jResp.StringOf("comment.attachments[i].thumbnails[j].height")
        $id = $jResp.StringOf("comment.attachments[i].thumbnails[j].id")
        $inline = $jResp.StringOf("comment.attachments[i].thumbnails[j].inline")
        $malware_access_override = $jResp.StringOf("comment.attachments[i].thumbnails[j].malware_access_override")
        $malware_scan_result = $jResp.StringOf("comment.attachments[i].thumbnails[j].malware_scan_result")
        $mapped_content_url = $jResp.StringOf("comment.attachments[i].thumbnails[j].mapped_content_url")
        $size = $jResp.StringOf("comment.attachments[i].thumbnails[j].size")
        $url = $jResp.StringOf("comment.attachments[i].thumbnails[j].url")
        $width = $jResp.StringOf("comment.attachments[i].thumbnails[j].width")
        $j = $j + 1
    }

    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("comment.uploads")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("comment.uploads[i]")
    $i = $i + 1
}

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}"
    }
  ]
}