Chilkat Online Tools

C# / Support API / Update Attachment for Malware

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "attachment": {
//     "malware_access_override": "<boolean>"
//   }
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("attachment.malware_access_override","<boolean>");

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

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);

Chilkat.HttpResponse resp = http.PTextSb("PUT","https://example.zendesk.com/api/v2/attachments/:attachment_id",sbRequestBody,"utf-8","application/json",false,false);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

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

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("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.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 "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "attachment": {
    "malware_access_override": "<boolean>"
  }
}'
https://example.zendesk.com/api/v2/attachments/:attachment_id

Postman Collection Item JSON

{
  "name": "Update Attachment for Malware",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"attachment\": {\n    \"malware_access_override\": \"<boolean>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/attachments/:attachment_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "attachments",
        ":attachment_id"
      ],
      "variable": [
        {
          "key": "attachment_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Toggles enabling or restricting agent access to attachments with detected malware.\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"attachment\": {\n    \"malware_access_override\": \"<boolean>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/attachments/:attachment_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "attachments",
            ":attachment_id"
          ],
          "variable": [
            {
              "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}"
    }
  ]
}