Chilkat Online Tools

autoit / Support API / Show Ticket After Changes

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id/macros/:macro_id/apply",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $iJ
Local $iCount_j
Local $strVal

Local $sAssignee_id = $oJResp.StringOf("result.ticket.assignee_id")
Local $sBody = $oJResp.StringOf("result.ticket.comment.body")
Local $sV_Public = $oJResp.StringOf("result.ticket.comment.public")
Local $sId = $oJResp.StringOf("result.ticket.fields.id")
Local $sValue = $oJResp.StringOf("result.ticket.fields.value")
Local $sGroup_id = $oJResp.StringOf("result.ticket.group_id")
Local $sTicketId = $oJResp.StringOf("result.ticket.id")
Local $sV_Url = $oJResp.StringOf("result.ticket.url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("result.ticket.comment.scoped_body")
While $i < $iCount_i
    $oJResp.I = $i
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("result.ticket.comment.scoped_body[i]")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $strVal = $oJResp.StringOf("result.ticket.comment.scoped_body[i][j]")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

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