SQL Server / Support API / Redact Comment Attachment
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'PUT', 'https://example.zendesk.com/api/v2/tickets/:ticket_id/comments/:comment_id/attachments/:attachment_id/redact'
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @content_type nvarchar(4000)
DECLARE @content_url nvarchar(4000)
DECLARE @deleted nvarchar(4000)
DECLARE @file_name nvarchar(4000)
DECLARE @height nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @inline nvarchar(4000)
DECLARE @malware_access_override nvarchar(4000)
DECLARE @malware_scan_result nvarchar(4000)
DECLARE @mapped_content_url nvarchar(4000)
DECLARE @size nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @width nvarchar(4000)
DECLARE @Content_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Content_type OUT, 'attachment.content_type'
DECLARE @Content_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Content_url OUT, 'attachment.content_url'
DECLARE @Deleted nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Deleted OUT, 'attachment.deleted'
DECLARE @File_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @File_name OUT, 'attachment.file_name'
DECLARE @Height nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Height OUT, 'attachment.height'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'attachment.id'
DECLARE @Inline nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Inline OUT, 'attachment.inline'
DECLARE @Malware_access_override nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Malware_access_override OUT, 'attachment.malware_access_override'
DECLARE @Malware_scan_result nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Malware_scan_result OUT, 'attachment.malware_scan_result'
DECLARE @Mapped_content_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Mapped_content_url OUT, 'attachment.mapped_content_url'
DECLARE @Size nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Size OUT, 'attachment.size'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'attachment.url'
DECLARE @Width nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Width OUT, 'attachment.width'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'attachment.thumbnails'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @content_type OUT, 'attachment.thumbnails[i].content_type'
EXEC sp_OAMethod @jResp, 'StringOf', @content_url OUT, 'attachment.thumbnails[i].content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @deleted OUT, 'attachment.thumbnails[i].deleted'
EXEC sp_OAMethod @jResp, 'StringOf', @file_name OUT, 'attachment.thumbnails[i].file_name'
EXEC sp_OAMethod @jResp, 'StringOf', @height OUT, 'attachment.thumbnails[i].height'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'attachment.thumbnails[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @inline OUT, 'attachment.thumbnails[i].inline'
EXEC sp_OAMethod @jResp, 'StringOf', @malware_access_override OUT, 'attachment.thumbnails[i].malware_access_override'
EXEC sp_OAMethod @jResp, 'StringOf', @malware_scan_result OUT, 'attachment.thumbnails[i].malware_scan_result'
EXEC sp_OAMethod @jResp, 'StringOf', @mapped_content_url OUT, 'attachment.thumbnails[i].mapped_content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @size OUT, 'attachment.thumbnails[i].size'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'attachment.thumbnails[i].url'
EXEC sp_OAMethod @jResp, 'StringOf', @width OUT, 'attachment.thumbnails[i].width'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
