Chilkat Online Tools

Swift / Support API / Update Attachment for Malware

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    json.UpdateString("attachment.malware_access_override", value: "<boolean>")

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

    let sbRequestBody = CkoStringBuilder()
    json.EmitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.PTextSb("PUT", url: "https://example.zendesk.com/api/v2/attachments/:attachment_id", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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: String?
    var content_url: String?
    var deleted: String?
    var file_name: String?
    var height: String?
    var id: String?
    var inline: String?
    var malware_access_override: String?
    var malware_scan_result: String?
    var mapped_content_url: String?
    var size: String?
    var url: String?
    var width: String?

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