Chilkat Online Tools

Node.js / Support API / Redact Comment Attachment

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "login";
    http.Password = "password";

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

    // resp: HttpResponse
    var resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/tickets/:ticket_id/comments/:comment_id/attachments/:attachment_id/redact");
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // 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

    var content_type;
    var content_url;
    var deleted;
    var file_name;
    var height;
    var id;
    var inline;
    var malware_access_override;
    var malware_scan_result;
    var mapped_content_url;
    var size;
    var url;
    var width;

    var Content_type = jResp.StringOf("attachment.content_type");
    var Content_url = jResp.StringOf("attachment.content_url");
    var Deleted = jResp.StringOf("attachment.deleted");
    var File_name = jResp.StringOf("attachment.file_name");
    var Height = jResp.StringOf("attachment.height");
    var Id = jResp.StringOf("attachment.id");
    var Inline = jResp.StringOf("attachment.inline");
    var Malware_access_override = jResp.StringOf("attachment.malware_access_override");
    var Malware_scan_result = jResp.StringOf("attachment.malware_scan_result");
    var Mapped_content_url = jResp.StringOf("attachment.mapped_content_url");
    var Size = jResp.StringOf("attachment.size");
    var v_Url = jResp.StringOf("attachment.url");
    var Width = jResp.StringOf("attachment.width");
    var i = 0;
    var count_i = jResp.SizeOfArray("attachment.thumbnails");
    while (i < count_i) {
        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;
    }


}

chilkatExample();

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