Chilkat Online Tools

autoit / Support API / Update Attachment for Malware

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"

; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

; The following JSON is sent in the request body.

; {
;   "attachment": {
;     "malware_access_override": "<boolean>"
;   }
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("attachment.malware_access_override","<boolean>")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://example.zendesk.com/api/v2/attachments/:attachment_id",$oSbRequestBody,"utf-8","application/json",False,False)
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)

; {
;   "attachment": {
;     "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>"
;       }
;     ]
;   }
; }

; 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 $sContent_type = $oJResp.StringOf("attachment.content_type")
Local $sContent_url = $oJResp.StringOf("attachment.content_url")
Local $sDeleted = $oJResp.StringOf("attachment.deleted")
Local $sFile_name = $oJResp.StringOf("attachment.file_name")
Local $sHeight = $oJResp.StringOf("attachment.height")
Local $sId = $oJResp.StringOf("attachment.id")
Local $sInline = $oJResp.StringOf("attachment.inline")
Local $sMalware_access_override = $oJResp.StringOf("attachment.malware_access_override")
Local $sMalware_scan_result = $oJResp.StringOf("attachment.malware_scan_result")
Local $sMapped_content_url = $oJResp.StringOf("attachment.mapped_content_url")
Local $sSize = $oJResp.StringOf("attachment.size")
Local $sV_Url = $oJResp.StringOf("attachment.url")
Local $sWidth = $oJResp.StringOf("attachment.width")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("attachment.thumbnails")
While $i < $iCount_i
    $oJResp.I = $i
    $sContent_type = $oJResp.StringOf("attachment.thumbnails[i].content_type")
    $sContent_url = $oJResp.StringOf("attachment.thumbnails[i].content_url")
    $sDeleted = $oJResp.StringOf("attachment.thumbnails[i].deleted")
    $sFile_name = $oJResp.StringOf("attachment.thumbnails[i].file_name")
    $sHeight = $oJResp.StringOf("attachment.thumbnails[i].height")
    $sId = $oJResp.StringOf("attachment.thumbnails[i].id")
    $sInline = $oJResp.StringOf("attachment.thumbnails[i].inline")
    $sMalware_access_override = $oJResp.StringOf("attachment.thumbnails[i].malware_access_override")
    $sMalware_scan_result = $oJResp.StringOf("attachment.thumbnails[i].malware_scan_result")
    $sMapped_content_url = $oJResp.StringOf("attachment.thumbnails[i].mapped_content_url")
    $size = $oJResp.StringOf("attachment.thumbnails[i].size")
    $sUrl = $oJResp.StringOf("attachment.thumbnails[i].url")
    $sWidth = $oJResp.StringOf("attachment.thumbnails[i].width")
    $i = $i + 1
Wend

Curl Command

curl  -u login:password -X PUT
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "attachment": {
    "malware_access_override": "<boolean>"
  }
}'
https://example.zendesk.com/api/v2/attachments/:attachment_id

Postman Collection Item JSON

{
  "name": "Update Attachment for Malware",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"attachment\": {\n    \"malware_access_override\": \"<boolean>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/attachments/:attachment_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "attachments",
        ":attachment_id"
      ],
      "variable": [
        {
          "key": "attachment_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Toggles enabling or restricting agent access to attachments with detected malware.\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"attachment\": {\n    \"malware_access_override\": \"<boolean>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/attachments/:attachment_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "attachments",
            ":attachment_id"
          ],
          "variable": [
            {
              "key": "attachment_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"attachment\": {\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}"
    }
  ]
}