Foxpro / Support API / Show Attachment
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcContent_type
LOCAL lcContent_url
LOCAL lcDeleted
LOCAL lcFile_name
LOCAL lcHeight
LOCAL lcId
LOCAL lcInline
LOCAL lcMalware_access_override
LOCAL lcMalware_scan_result
LOCAL lcMapped_content_url
LOCAL lcSize
LOCAL lcUrl
LOCAL lcWidth
LOCAL lcContent_type
LOCAL lcContent_url
LOCAL lcDeleted
LOCAL lcFile_name
LOCAL lcHeight
LOCAL lcId
LOCAL lcInline
LOCAL lcMalware_access_override
LOCAL lcMalware_scan_result
LOCAL lcMapped_content_url
LOCAL lcSize
LOCAL lcV_Url
LOCAL lcWidth
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/attachments/:attachment_id",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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
lcContent_type = loJResp.StringOf("attachment.content_type")
lcContent_url = loJResp.StringOf("attachment.content_url")
lcDeleted = loJResp.StringOf("attachment.deleted")
lcFile_name = loJResp.StringOf("attachment.file_name")
lcHeight = loJResp.StringOf("attachment.height")
lcId = loJResp.StringOf("attachment.id")
lcInline = loJResp.StringOf("attachment.inline")
lcMalware_access_override = loJResp.StringOf("attachment.malware_access_override")
lcMalware_scan_result = loJResp.StringOf("attachment.malware_scan_result")
lcMapped_content_url = loJResp.StringOf("attachment.mapped_content_url")
lcSize = loJResp.StringOf("attachment.size")
lcV_Url = loJResp.StringOf("attachment.url")
lcWidth = loJResp.StringOf("attachment.width")
i = 0
lnCount_i = loJResp.SizeOfArray("attachment.thumbnails")
DO WHILE i < lnCount_i
loJResp.I = i
lcContent_type = loJResp.StringOf("attachment.thumbnails[i].content_type")
lcContent_url = loJResp.StringOf("attachment.thumbnails[i].content_url")
lcDeleted = loJResp.StringOf("attachment.thumbnails[i].deleted")
lcFile_name = loJResp.StringOf("attachment.thumbnails[i].file_name")
lcHeight = loJResp.StringOf("attachment.thumbnails[i].height")
lcId = loJResp.StringOf("attachment.thumbnails[i].id")
lcInline = loJResp.StringOf("attachment.thumbnails[i].inline")
lcMalware_access_override = loJResp.StringOf("attachment.thumbnails[i].malware_access_override")
lcMalware_scan_result = loJResp.StringOf("attachment.thumbnails[i].malware_scan_result")
lcMapped_content_url = loJResp.StringOf("attachment.thumbnails[i].mapped_content_url")
lcSize = loJResp.StringOf("attachment.thumbnails[i].size")
lcUrl = loJResp.StringOf("attachment.thumbnails[i].url")
lcWidth = loJResp.StringOf("attachment.thumbnails[i].width")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}