Chilkat Online Tools

Perl / Support API / Show Attachment

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("password");

$http->SetRequestHeader("Accept","application/json");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://example.zendesk.com/api/v2/attachments/:attachment_id",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# 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) {
    $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 GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/attachments/:attachment_id

Postman Collection Item JSON

{
  "name": "Show Attachment",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/attachments/:attachment_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "attachments",
        ":attachment_id"
      ],
      "variable": [
        {
          "key": "attachment_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Shows attachment details. You can get the value of the `attachment_id` parameter by listing the ticket's comments.\nSee [List Comments](/api-reference/ticketing/tickets/ticket_comments/#list-comments). Each comment\nin the list has an `attachments` list that specifies an `id` for each attachment.\n\n\n #### Allowed for\n\n * Agents\n"
  },
  "response": [
    {
      "name": "Success Response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "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}"
    }
  ]
}