PowerBuilder / Support API / Upload Files
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Content_type
string ls_Content_url
string ls_Deleted
string ls_File_name
string ls_Height
string ls_Id
string ls_Inline
string ls_Malware_access_override
string ls_Malware_scan_result
string ls_Mapped_content_url
string ls_Size
string ls_Url
string ls_Width
integer j
integer li_Count_j
string ls_Content_type
string ls_Content_url
string ls_Deleted
string ls_File_name
string ls_Height
string ls_Id
string ls_Inline
string ls_Malware_access_override
string ls_Malware_scan_result
string ls_Mapped_content_url
string ls_Size
string ls_V_Url
string ls_Width
string ls_Token
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequest("POST","https://example.zendesk.com/api/v2/uploads")
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "upload": {
// "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>"
// }
// ]
// },
// "attachments": [
// {
// "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>"
// }
// ]
// },
// {
// "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>"
// }
// ]
// }
// ],
// "token": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Content_type = loo_JResp.StringOf("upload.attachment.content_type")
ls_Content_url = loo_JResp.StringOf("upload.attachment.content_url")
ls_Deleted = loo_JResp.StringOf("upload.attachment.deleted")
ls_File_name = loo_JResp.StringOf("upload.attachment.file_name")
ls_Height = loo_JResp.StringOf("upload.attachment.height")
ls_Id = loo_JResp.StringOf("upload.attachment.id")
ls_Inline = loo_JResp.StringOf("upload.attachment.inline")
ls_Malware_access_override = loo_JResp.StringOf("upload.attachment.malware_access_override")
ls_Malware_scan_result = loo_JResp.StringOf("upload.attachment.malware_scan_result")
ls_Mapped_content_url = loo_JResp.StringOf("upload.attachment.mapped_content_url")
ls_Size = loo_JResp.StringOf("upload.attachment.size")
ls_V_Url = loo_JResp.StringOf("upload.attachment.url")
ls_Width = loo_JResp.StringOf("upload.attachment.width")
ls_Token = loo_JResp.StringOf("upload.token")
i = 0
li_Count_i = loo_JResp.SizeOfArray("upload.attachment.thumbnails")
do while i < li_Count_i
loo_JResp.I = i
ls_Content_type = loo_JResp.StringOf("upload.attachment.thumbnails[i].content_type")
ls_Content_url = loo_JResp.StringOf("upload.attachment.thumbnails[i].content_url")
ls_Deleted = loo_JResp.StringOf("upload.attachment.thumbnails[i].deleted")
ls_File_name = loo_JResp.StringOf("upload.attachment.thumbnails[i].file_name")
ls_Height = loo_JResp.StringOf("upload.attachment.thumbnails[i].height")
ls_Id = loo_JResp.StringOf("upload.attachment.thumbnails[i].id")
ls_Inline = loo_JResp.StringOf("upload.attachment.thumbnails[i].inline")
ls_Malware_access_override = loo_JResp.StringOf("upload.attachment.thumbnails[i].malware_access_override")
ls_Malware_scan_result = loo_JResp.StringOf("upload.attachment.thumbnails[i].malware_scan_result")
ls_Mapped_content_url = loo_JResp.StringOf("upload.attachment.thumbnails[i].mapped_content_url")
ls_Size = loo_JResp.StringOf("upload.attachment.thumbnails[i].size")
ls_Url = loo_JResp.StringOf("upload.attachment.thumbnails[i].url")
ls_Width = loo_JResp.StringOf("upload.attachment.thumbnails[i].width")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("upload.attachments")
do while i < li_Count_i
loo_JResp.I = i
ls_Content_type = loo_JResp.StringOf("upload.attachments[i].content_type")
ls_Content_url = loo_JResp.StringOf("upload.attachments[i].content_url")
ls_Deleted = loo_JResp.StringOf("upload.attachments[i].deleted")
ls_File_name = loo_JResp.StringOf("upload.attachments[i].file_name")
ls_Height = loo_JResp.StringOf("upload.attachments[i].height")
ls_Id = loo_JResp.StringOf("upload.attachments[i].id")
ls_Inline = loo_JResp.StringOf("upload.attachments[i].inline")
ls_Malware_access_override = loo_JResp.StringOf("upload.attachments[i].malware_access_override")
ls_Malware_scan_result = loo_JResp.StringOf("upload.attachments[i].malware_scan_result")
ls_Mapped_content_url = loo_JResp.StringOf("upload.attachments[i].mapped_content_url")
ls_Size = loo_JResp.StringOf("upload.attachments[i].size")
ls_Url = loo_JResp.StringOf("upload.attachments[i].url")
ls_Width = loo_JResp.StringOf("upload.attachments[i].width")
j = 0
li_Count_j = loo_JResp.SizeOfArray("upload.attachments[i].thumbnails")
do while j < li_Count_j
loo_JResp.J = j
ls_Content_type = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].content_type")
ls_Content_url = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].content_url")
ls_Deleted = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].deleted")
ls_File_name = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].file_name")
ls_Height = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].height")
ls_Id = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].id")
ls_Inline = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].inline")
ls_Malware_access_override = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].malware_access_override")
ls_Malware_scan_result = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].malware_scan_result")
ls_Mapped_content_url = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].mapped_content_url")
ls_Size = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].size")
ls_Url = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].url")
ls_Width = loo_JResp.StringOf("upload.attachments[i].thumbnails[j].width")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/uploads
Postman Collection Item JSON
{
"name": "Upload Files",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/uploads",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"uploads"
]
},
"description": "Uploads a file that can be attached to a ticket comment. It doesn't attach the file to the comment. For details and examples, see [Attaching ticket comments with the API](/documentation/ticketing/using-the-zendesk-api/adding-ticket-attachments-with-the-api).\n\nThe endpoint has a required `filename` query parameter. The parameter specifies what the file will be named when attached to the ticket comment (to give the agent more context about the file). The parameter does not specify the file on the local system to be uploaded. While the two names can be different, their file extensions must be the same. If they don't match, the agent's browser or file reader could give an error when attempting to open the attachment.\n\nThe `Content-Type` header must contain a recognized MIME type that correctly describes the type of the uploaded file. Failing to send a recognized, correct type may cause undesired behavior. For example, in-browser audio playback may be interrupted by the browser's security mechanisms for MP3s uploaded with an incorrect type.\n\nAdding multiple files to the same upload is handled by splitting requests and passing the API token received from the first request to each subsequent request. The token is valid for 3 days.\n\n**Note**: Even if [private attachments](https://support.zendesk.com/hc/en-us/articles/204265396) are enabled in the Zendesk Support instance, uploaded files are visible to any authenticated user at the `content_URL` specified in the [JSON response](#json-format) until the upload token is consumed. Once a file is associated with a ticket or post, visibility is restricted to users with access to the ticket or post with the attachment.\n\n#### Allowed For\n\n* End users\n"
},
"response": [
{
"name": "Created response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/uploads",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"uploads"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"upload\": {\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 \"attachments\": [\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 \"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 {\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 ],\n \"token\": \"<string>\"\n }\n}"
}
]
}
