Jira Cloud: Download an Issue Attachment
See more Jira Examples
Find an attachment by issue key and filename, obtain its ID from issue metadata, and download it through the documented attachment-content endpoint. The code requires exactly one matching filename; if duplicates exist, select an attachment ID explicitly using its author or creation time.
The example asks Jira to return content without a redirect and handles an HTTPS redirect if one is returned. A separate Http object downloads a signed URL without forwarding the Jira credentials. The destination is an application-chosen local path, not an untrusted server filename. Create the output directory first. This simple version buffers the response in memory, so use a streaming download for very large attachments.
The code uses an Atlassian account email and an API token without scopes with the site URL. For a scoped API token, keep Basic authentication and change baseUrl to https://api.atlassian.com/ex/jira/YOUR_CLOUD_ID. For OAuth2, use that gateway URL, omit Login/Password/BasicAuth, and set http.AuthToken to the access token. See API token authentication and OAuth2 authorization. The account must have permission for the operation; OAuth scopes do not grant additional Jira permissions.
Targets Jira Cloud. Jira Data Center has a separate REST API and may require different paths, authentication, or payloads.
Atlassian REST API documentation
Chilkat Unicode C++ Downloads
#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
bool success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
CkHttpW http;
http.put_RequireSslCertVerify(true);
http.put_BasicAuth(true);
// Read these credentials from private application configuration.
http.put_Login(L"YOUR_ATLASSIAN_EMAIL");
http.put_Password(L"YOUR_API_TOKEN");
const wchar_t *baseUrl = L"https://your-domain.atlassian.net";
http.put_Accept(L"application/json");
CkStringBuilderW url;
CkHttpResponseW resp;
CkJsonObjectW reply;
const wchar_t *issueKey = L"PROJECT-123";
http.SetUrlVar(L"issueKey",issueKey);
const wchar_t *attachmentName = L"report.pdf";
const wchar_t *attachmentId = L"";
const wchar_t *localPath = L"qa_output/report.pdf";
int matches = 0;
url.SetString(baseUrl);
url.Append(L"/rest/api/3/issue/{$issueKey}?fields=attachment");
success = http.HttpNoBody(L"GET",url.getAsString(),resp);
if (resp.get_StatusCode() == 0) {
wprintf(L"No HTTP response was received. Check connectivity and TLS settings.\n");
return;
}
if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
wprintf(L"Request failed. HTTP %d\n",resp.get_StatusCode());
if (resp.get_StatusCode() == 429) {
wprintf(L"Rate limited. Retry-After: %s\n",resp.getHeaderField(L"Retry-After"));
}
// Inspect this response locally; it can contain private Jira data.
wprintf(L"%s\n",resp.bodyStr());
return;
}
success = reply.Load(resp.bodyStr());
if (success != true) {
wprintf(L"Expected a JSON object in the response.\n");
return;
}
if (reply.JsonTypeOf(L"fields.attachment") != 4) {
wprintf(L"Expected an array: fields.attachment\n");
return;
}
int i = 0;
while ((i < reply.SizeOfArray(L"fields.attachment"))) {
reply.put_I(i);
if (reply.StringOfEquals(L"fields.attachment[i].filename",attachmentName,true) == true) {
attachmentId = reply.stringOf(L"fields.attachment[i].id");
matches = matches + 1;
}
i = i + 1;
}
if ((matches != 1) || (attachmentId == L"")) {
wprintf(L"Expected exactly one attachment with this filename. Matches: %d\n",matches);
return;
}
http.SetUrlVar(L"attachmentId",attachmentId);
http.put_FollowRedirects(false);
http.put_Accept(L"*/*");
url.SetString(baseUrl);
url.Append(L"/rest/api/3/attachment/content/{$attachmentId}?redirect=false");
success = http.HttpNoBody(L"GET",url.getAsString(),resp);
if ((resp.get_StatusCode() == 302) || (resp.get_StatusCode() == 303) || (resp.get_StatusCode() == 307)) {
CkStringBuilderW location;
location.SetString(resp.getHeaderField(L"Location"));
if (location.StartsWith(L"https://",false) != true) {
wprintf(L"Expected an HTTPS attachment redirect.\n");
return;
}
CkHttpW download;
download.put_RequireSslCertVerify(true);
// The signed URL authorizes this request; do not add Jira credentials.
success = download.HttpNoBody(L"GET",location.getAsString(),resp);
}
if ((success != true) || (resp.get_StatusCode() != 200)) {
wprintf(L"Attachment download failed. HTTP %d\n",resp.get_StatusCode());
return;
}
success = resp.SaveBodyBinary(localPath);
if (success != true) {
wprintf(L"Could not save the downloaded attachment.\n");
return;
}
wprintf(L"Saved attachment to %s\n",localPath);
}