Chilkat Online Tools

TCL / Support API / Show Ticket After Changes

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/tickets/:ticket_id/macros/:macro_id/apply" $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)

# {
#   "result": {
#     "ticket": {
#       "assignee_id": "<integer>",
#       "comment": {
#         "body": "<string>",
#         "public": "<boolean>",
#         "scoped_body": [
#           [
#             "<string>",
#             "<string>"
#           ],
#           [
#             "<string>",
#             "<string>"
#           ]
#         ]
#       },
#       "fields": {
#         "id": "<integer>",
#         "value": "<string>"
#       },
#       "group_id": "<integer>",
#       "id": "<integer>",
#       "url": "<string>"
#     }
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set Assignee_id [CkJsonObject_stringOf $jResp "result.ticket.assignee_id"]
set Body [CkJsonObject_stringOf $jResp "result.ticket.comment.body"]
set v_Public [CkJsonObject_stringOf $jResp "result.ticket.comment.public"]
set Id [CkJsonObject_stringOf $jResp "result.ticket.fields.id"]
set Value [CkJsonObject_stringOf $jResp "result.ticket.fields.value"]
set Group_id [CkJsonObject_stringOf $jResp "result.ticket.group_id"]
set TicketId [CkJsonObject_stringOf $jResp "result.ticket.id"]
set v_Url [CkJsonObject_stringOf $jResp "result.ticket.url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "result.ticket.comment.scoped_body"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "result.ticket.comment.scoped_body[i]"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "result.ticket.comment.scoped_body[i][j]"]
        set j [expr $j + 1]
    }
    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/tickets/:ticket_id/macros/:macro_id/apply

Postman Collection Item JSON

{
  "name": "Show Ticket After Changes",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/macros/:macro_id/apply",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        ":ticket_id",
        "macros",
        ":macro_id",
        "apply"
      ],
      "variable": [
        {
          "key": "ticket_id",
          "value": "<integer>"
        },
        {
          "key": "macro_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns the full ticket object as it would be after applying the macro to the ticket.\nIt doesn't actually change the ticket.\n\nTo get only the ticket fields that would be changed by the macro,\nsee [Show Changes to Ticket](#show-changes-to-ticket).\n\n#### Allowed For\n\n* Agents\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/tickets/:ticket_id/macros/:macro_id/apply",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            ":ticket_id",
            "macros",
            ":macro_id",
            "apply"
          ],
          "variable": [
            {
              "key": "ticket_id"
            },
            {
              "key": "macro_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"result\": {\n    \"ticket\": {\n      \"assignee_id\": \"<integer>\",\n      \"comment\": {\n        \"body\": \"<string>\",\n        \"public\": \"<boolean>\",\n        \"scoped_body\": [\n          [\n            \"<string>\",\n            \"<string>\"\n          ],\n          [\n            \"<string>\",\n            \"<string>\"\n          ]\n        ]\n      },\n      \"fields\": {\n        \"id\": \"<integer>\",\n        \"value\": \"<string>\"\n      },\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"url\": \"<string>\"\n    }\n  }\n}"
    }
  ]
}