Chilkat Online Tools

autoit / Support API / Suspended Ticket Attachments

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"

Local $oResp = $oHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/suspended_tickets/attachments")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

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

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

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "upload": {
;     "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>"
;           }
;         ]
;       }
;     ],
;     "token": "<string>"
;   }
; }

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

Local $sContent_type
Local $sContent_url
Local $sDeleted
Local $sFile_name
Local $sHeight
Local $sId
Local $sInline
Local $sMalware_access_override
Local $sMalware_scan_result
Local $sMapped_content_url
Local $size
Local $sUrl
Local $sWidth
Local $iJ
Local $iCount_j

Local $sToken = $oJResp.StringOf("upload.token")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("upload.attachments")
While $i < $iCount_i
    $oJResp.I = $i
    $sContent_type = $oJResp.StringOf("upload.attachments[i].content_type")
    $sContent_url = $oJResp.StringOf("upload.attachments[i].content_url")
    $sDeleted = $oJResp.StringOf("upload.attachments[i].deleted")
    $sFile_name = $oJResp.StringOf("upload.attachments[i].file_name")
    $sHeight = $oJResp.StringOf("upload.attachments[i].height")
    $sId = $oJResp.StringOf("upload.attachments[i].id")
    $sInline = $oJResp.StringOf("upload.attachments[i].inline")
    $sMalware_access_override = $oJResp.StringOf("upload.attachments[i].malware_access_override")
    $sMalware_scan_result = $oJResp.StringOf("upload.attachments[i].malware_scan_result")
    $sMapped_content_url = $oJResp.StringOf("upload.attachments[i].mapped_content_url")
    $size = $oJResp.StringOf("upload.attachments[i].size")
    $sUrl = $oJResp.StringOf("upload.attachments[i].url")
    $sWidth = $oJResp.StringOf("upload.attachments[i].width")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("upload.attachments[i].thumbnails")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sContent_type = $oJResp.StringOf("upload.attachments[i].thumbnails[j].content_type")
        $sContent_url = $oJResp.StringOf("upload.attachments[i].thumbnails[j].content_url")
        $sDeleted = $oJResp.StringOf("upload.attachments[i].thumbnails[j].deleted")
        $sFile_name = $oJResp.StringOf("upload.attachments[i].thumbnails[j].file_name")
        $sHeight = $oJResp.StringOf("upload.attachments[i].thumbnails[j].height")
        $sId = $oJResp.StringOf("upload.attachments[i].thumbnails[j].id")
        $sInline = $oJResp.StringOf("upload.attachments[i].thumbnails[j].inline")
        $sMalware_access_override = $oJResp.StringOf("upload.attachments[i].thumbnails[j].malware_access_override")
        $sMalware_scan_result = $oJResp.StringOf("upload.attachments[i].thumbnails[j].malware_scan_result")
        $sMapped_content_url = $oJResp.StringOf("upload.attachments[i].thumbnails[j].mapped_content_url")
        $size = $oJResp.StringOf("upload.attachments[i].thumbnails[j].size")
        $sUrl = $oJResp.StringOf("upload.attachments[i].thumbnails[j].url")
        $sWidth = $oJResp.StringOf("upload.attachments[i].thumbnails[j].width")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/suspended_tickets/attachments

Postman Collection Item JSON

{
  "name": "Suspended Ticket Attachments",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/suspended_tickets/attachments",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "suspended_tickets",
        "attachments"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<number>",
          "description": "(Required) id of the suspended ticket"
        }
      ]
    },
    "description": "Makes copies of any attachments on a suspended ticket and returns them as [attachment tokens](/api-reference/ticketing/tickets/ticket-attachments/). If the  ticket is manually recovered, you can include the attachment tokens on the new ticket.\n\n#### Allowed For\n\n* Unrestricted agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/suspended_tickets/attachments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "suspended_tickets",
            "attachments"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"upload\": {\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    \"token\": \"<string>\"\n  }\n}"
    }
  ]
}