PowerBuilder / Support API / Redact Comment Attachment
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Content_type
string ls_Content_url
string ls_Deleted
string ls_File_name
string ls_Height
string ls_Id
string ls_Inline
string ls_Malware_access_override
string ls_Malware_scan_result
string ls_Mapped_content_url
string ls_Size
string ls_Url
string ls_Width
string ls_Content_type
string ls_Content_url
string ls_Deleted
string ls_File_name
string ls_Height
string ls_Id
string ls_Inline
string ls_Malware_access_override
string ls_Malware_scan_result
string ls_Mapped_content_url
string ls_Size
string ls_V_Url
string ls_Width
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequest("PUT","https://example.zendesk.com/api/v2/tickets/:ticket_id/comments/:comment_id/attachments/:attachment_id/redact")
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Content_type = loo_JResp.StringOf("attachment.content_type")
ls_Content_url = loo_JResp.StringOf("attachment.content_url")
ls_Deleted = loo_JResp.StringOf("attachment.deleted")
ls_File_name = loo_JResp.StringOf("attachment.file_name")
ls_Height = loo_JResp.StringOf("attachment.height")
ls_Id = loo_JResp.StringOf("attachment.id")
ls_Inline = loo_JResp.StringOf("attachment.inline")
ls_Malware_access_override = loo_JResp.StringOf("attachment.malware_access_override")
ls_Malware_scan_result = loo_JResp.StringOf("attachment.malware_scan_result")
ls_Mapped_content_url = loo_JResp.StringOf("attachment.mapped_content_url")
ls_Size = loo_JResp.StringOf("attachment.size")
ls_V_Url = loo_JResp.StringOf("attachment.url")
ls_Width = loo_JResp.StringOf("attachment.width")
i = 0
li_Count_i = loo_JResp.SizeOfArray("attachment.thumbnails")
do while i < li_Count_i
loo_JResp.I = i
ls_Content_type = loo_JResp.StringOf("attachment.thumbnails[i].content_type")
ls_Content_url = loo_JResp.StringOf("attachment.thumbnails[i].content_url")
ls_Deleted = loo_JResp.StringOf("attachment.thumbnails[i].deleted")
ls_File_name = loo_JResp.StringOf("attachment.thumbnails[i].file_name")
ls_Height = loo_JResp.StringOf("attachment.thumbnails[i].height")
ls_Id = loo_JResp.StringOf("attachment.thumbnails[i].id")
ls_Inline = loo_JResp.StringOf("attachment.thumbnails[i].inline")
ls_Malware_access_override = loo_JResp.StringOf("attachment.thumbnails[i].malware_access_override")
ls_Malware_scan_result = loo_JResp.StringOf("attachment.thumbnails[i].malware_scan_result")
ls_Mapped_content_url = loo_JResp.StringOf("attachment.thumbnails[i].mapped_content_url")
ls_Size = loo_JResp.StringOf("attachment.thumbnails[i].size")
ls_Url = loo_JResp.StringOf("attachment.thumbnails[i].url")
ls_Width = loo_JResp.StringOf("attachment.thumbnails[i].width")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/comments/:comment_id/attachments/:attachment_id/redact
Postman Collection Item JSON
{
"name": "Redact Comment Attachment",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/comments/:comment_id/attachments/:attachment_id/redact",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"comments",
":comment_id",
"attachments",
":attachment_id",
"redact"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
},
{
"key": "comment_id",
"value": "<integer>"
},
{
"key": "attachment_id",
"value": "<integer>"
}
]
},
"description": "Redaction allows you to permanently remove attachments from an existing comment on a ticket. Once removed from a comment, the attachment is replaced with an empty \"redacted.txt\" file.\n\nThe redaction is permanent. It is not possible to undo redaction or see what was removed. Once a ticket is closed, redacting its attachments is no longer possible.\n\nAlso, if you want to redact an inline attachment, you can use the `include_inline_images` parameter in the [List Comments](/api-reference/ticketing/tickets/ticket_comments/#list-comments) operation to obtain the inline attachment ID, and use it in the request URL.\n\n#### Allowed For\n\n* Admins\n* Agents when [deleting tickets is enabled for agents on professional accounts](https://support.zendesk.com/hc/en-us/articles/360002128107)\n* Agents assigned to a custom role with permissions to redact ticket content (Enterprise only)\n"
},
"response": [
{
"name": "OK response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/comments/:comment_id/attachments/:attachment_id/redact",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"comments",
":comment_id",
"attachments",
":attachment_id",
"redact"
],
"variable": [
{
"key": "ticket_id"
},
{
"key": "comment_id"
},
{
"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}"
}
]
}
