Chilkat Online Tools

Java / Support API / Redact Comment Attachment

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

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

    CkHttpResponse resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/tickets/:ticket_id/comments/:comment_id/attachments/:attachment_id/redact");
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("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

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

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

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