Chilkat Online Tools

delphiAx / Support API / Redact Comment Attachment

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
content_type: WideString;
content_url: WideString;
deleted: WideString;
file_name: WideString;
height: WideString;
id: WideString;
inline: WideString;
malware_access_override: WideString;
malware_scan_result: WideString;
mapped_content_url: WideString;
size: WideString;
url: WideString;
width: WideString;
Content_type: WideString;
Content_url: WideString;
Deleted: WideString;
File_name: WideString;
Height: WideString;
Id: WideString;
Inline: WideString;
Malware_access_override: WideString;
Malware_scan_result: WideString;
Mapped_content_url: WideString;
Size: WideString;
v_Url: WideString;
Width: WideString;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

http.SetRequestHeader('Accept','application/json');

resp := http.QuickRequest('PUT','https://example.zendesk.com/api/v2/tickets/:ticket_id/comments/:comment_id/attachments/:attachment_id/redact');
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// 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 do
  begin
    jResp.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;
  end;

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}"
    }
  ]
}