lianja / 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.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.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>"
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("attachment.malware_access_override","<boolean>")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://example.zendesk.com/api/v2/attachments/:attachment_id",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcContent_type = loJResp.StringOf("attachment.content_type")
lcContent_url = loJResp.StringOf("attachment.content_url")
lcDeleted = loJResp.StringOf("attachment.deleted")
lcFile_name = loJResp.StringOf("attachment.file_name")
lcHeight = loJResp.StringOf("attachment.height")
lcId = loJResp.StringOf("attachment.id")
lcInline = loJResp.StringOf("attachment.inline")
lcMalware_access_override = loJResp.StringOf("attachment.malware_access_override")
lcMalware_scan_result = loJResp.StringOf("attachment.malware_scan_result")
lcMapped_content_url = loJResp.StringOf("attachment.mapped_content_url")
lcSize = loJResp.StringOf("attachment.size")
lcV_Url = loJResp.StringOf("attachment.url")
lcWidth = loJResp.StringOf("attachment.width")
i = 0
lnCount_i = loJResp.SizeOfArray("attachment.thumbnails")
do while i < lnCount_i
loJResp.I = i
lcContent_type = loJResp.StringOf("attachment.thumbnails[i].content_type")
lcContent_url = loJResp.StringOf("attachment.thumbnails[i].content_url")
lcDeleted = loJResp.StringOf("attachment.thumbnails[i].deleted")
lcFile_name = loJResp.StringOf("attachment.thumbnails[i].file_name")
lcHeight = loJResp.StringOf("attachment.thumbnails[i].height")
lcId = loJResp.StringOf("attachment.thumbnails[i].id")
lcInline = loJResp.StringOf("attachment.thumbnails[i].inline")
lcMalware_access_override = loJResp.StringOf("attachment.thumbnails[i].malware_access_override")
lcMalware_scan_result = loJResp.StringOf("attachment.thumbnails[i].malware_scan_result")
lcMapped_content_url = loJResp.StringOf("attachment.thumbnails[i].mapped_content_url")
lcSize = loJResp.StringOf("attachment.thumbnails[i].size")
lcUrl = loJResp.StringOf("attachment.thumbnails[i].url")
lcWidth = loJResp.StringOf("attachment.thumbnails[i].width")
i = i + 1
enddo
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
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}"
}
]
}
