Perl / Support API / Update Attachment for Malware
Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_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>"
# }
# }
$json = chilkat::CkJsonObject->new();
$json->UpdateString("attachment.malware_access_override","<boolean>");
$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Accept","application/json");
$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);
# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://example.zendesk.com/api/v2/attachments/:attachment_id",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# 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
$Content_type = $jResp->stringOf("attachment.content_type");
$Content_url = $jResp->stringOf("attachment.content_url");
$Deleted = $jResp->stringOf("attachment.deleted");
$File_name = $jResp->stringOf("attachment.file_name");
$Height = $jResp->stringOf("attachment.height");
$Id = $jResp->stringOf("attachment.id");
$Inline = $jResp->stringOf("attachment.inline");
$Malware_access_override = $jResp->stringOf("attachment.malware_access_override");
$Malware_scan_result = $jResp->stringOf("attachment.malware_scan_result");
$Mapped_content_url = $jResp->stringOf("attachment.mapped_content_url");
$Size = $jResp->stringOf("attachment.size");
$v_Url = $jResp->stringOf("attachment.url");
$Width = $jResp->stringOf("attachment.width");
$i = 0;
$count_i = $jResp->SizeOfArray("attachment.thumbnails");
while ($i < $count_i) {
$jResp->put_I($i);
$content_type = $jResp->stringOf("attachment.thumbnails[i].content_type");
$content_url = $jResp->stringOf("attachment.thumbnails[i].content_url");
$deleted = $jResp->stringOf("attachment.thumbnails[i].deleted");
$file_name = $jResp->stringOf("attachment.thumbnails[i].file_name");
$height = $jResp->stringOf("attachment.thumbnails[i].height");
$id = $jResp->stringOf("attachment.thumbnails[i].id");
$inline = $jResp->stringOf("attachment.thumbnails[i].inline");
$malware_access_override = $jResp->stringOf("attachment.thumbnails[i].malware_access_override");
$malware_scan_result = $jResp->stringOf("attachment.thumbnails[i].malware_scan_result");
$mapped_content_url = $jResp->stringOf("attachment.thumbnails[i].mapped_content_url");
$size = $jResp->stringOf("attachment.thumbnails[i].size");
$url = $jResp->stringOf("attachment.thumbnails[i].url");
$width = $jResp->stringOf("attachment.thumbnails[i].width");
$i = $i + 1;
}
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}"
}
]
}
