TCL / Support API / Update Attachment for Malware
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"
# 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>"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "attachment.malware_access_override" "<boolean>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://example.zendesk.com/api/v2/attachments/:attachment_id" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Content_type [CkJsonObject_stringOf $jResp "attachment.content_type"]
set Content_url [CkJsonObject_stringOf $jResp "attachment.content_url"]
set Deleted [CkJsonObject_stringOf $jResp "attachment.deleted"]
set File_name [CkJsonObject_stringOf $jResp "attachment.file_name"]
set Height [CkJsonObject_stringOf $jResp "attachment.height"]
set Id [CkJsonObject_stringOf $jResp "attachment.id"]
set Inline [CkJsonObject_stringOf $jResp "attachment.inline"]
set Malware_access_override [CkJsonObject_stringOf $jResp "attachment.malware_access_override"]
set Malware_scan_result [CkJsonObject_stringOf $jResp "attachment.malware_scan_result"]
set Mapped_content_url [CkJsonObject_stringOf $jResp "attachment.mapped_content_url"]
set Size [CkJsonObject_stringOf $jResp "attachment.size"]
set v_Url [CkJsonObject_stringOf $jResp "attachment.url"]
set Width [CkJsonObject_stringOf $jResp "attachment.width"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "attachment.thumbnails"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set content_type [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].content_type"]
set content_url [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].content_url"]
set deleted [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].deleted"]
set file_name [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].file_name"]
set height [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].height"]
set id [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].id"]
set inline [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].inline"]
set malware_access_override [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].malware_access_override"]
set malware_scan_result [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].malware_scan_result"]
set mapped_content_url [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].mapped_content_url"]
set size [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].size"]
set url [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].url"]
set width [CkJsonObject_stringOf $jResp "attachment.thumbnails[i].width"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
