Sample code for 30+ languages & platforms
Visual FoxPro Requires Chilkat v11.0.0+

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 Visual FoxPro Downloads

Visual FoxPro
LOCAL lnSuccess
LOCAL loHttp
LOCAL lcBaseUrl
LOCAL loUrl
LOCAL loResp
LOCAL loReply
LOCAL lcIssueKey
LOCAL lcAttachmentName
LOCAL lcAttachmentId
LOCAL lcLocalPath
LOCAL lnMatches
LOCAL i
LOCAL loLocation
LOCAL loDownload

lnSuccess = 0

*  Assumes Chilkat is unlocked. See Global Unlock Sample.

loHttp = CreateObject('Chilkat.Http')
loHttp.RequireSslCertVerify = 1
loHttp.BasicAuth = 1
*  Read these credentials from private application configuration.
loHttp.Login = "YOUR_ATLASSIAN_EMAIL"
loHttp.Password = "YOUR_API_TOKEN"
lcBaseUrl = "https://your-domain.atlassian.net"
loHttp.Accept = "application/json"
loUrl = CreateObject('Chilkat.StringBuilder')
loResp = CreateObject('Chilkat.HttpResponse')
loReply = CreateObject('Chilkat.JsonObject')
lcIssueKey = "PROJECT-123"
loHttp.SetUrlVar("issueKey",lcIssueKey)
lcAttachmentName = "report.pdf"
lcAttachmentId = ""
lcLocalPath = "qa_output/report.pdf"
lnMatches = 0
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/api/3/issue/{$issueKey}?fields=attachment")
lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
IF (loResp.StatusCode = 0) THEN
    ? "No HTTP response was received. Check connectivity and TLS settings."
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    CANCEL
ENDIF

IF ((lnSuccess <> 1) OR (loResp.StatusCode < 200) OR (loResp.StatusCode >= 300)) THEN
    ? "Request failed. HTTP " + STR(loResp.StatusCode)
    IF (loResp.StatusCode = 429) THEN
        ? "Rate limited. Retry-After: " + loResp.GetHeaderField("Retry-After")
    ENDIF

    *  Inspect this response locally; it can contain private Jira data.
    ? loResp.BodyStr
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    CANCEL
ENDIF

lnSuccess = loReply.Load(loResp.BodyStr)
IF (lnSuccess <> 1) THEN
    ? "Expected a JSON object in the response."
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    CANCEL
ENDIF

IF (loReply.JsonTypeOf("fields.attachment") <> 4) THEN
    ? "Expected an array: fields.attachment"
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    CANCEL
ENDIF

i = 0
DO WHILE (i < loReply.SizeOfArray("fields.attachment"))
    loReply.I = i
    IF (loReply.StringOfEquals("fields.attachment[i].filename",lcAttachmentName,1) = 1) THEN
        lcAttachmentId = loReply.StringOf("fields.attachment[i].id")
        lnMatches = lnMatches + 1
    ENDIF

    i = i + 1
ENDDO
IF ((lnMatches <> 1) OR (lcAttachmentId = "")) THEN
    ? "Expected exactly one attachment with this filename. Matches: " + STR(lnMatches)
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    CANCEL
ENDIF

loHttp.SetUrlVar("attachmentId",lcAttachmentId)
loHttp.FollowRedirects = 0
loHttp.Accept = "*/*"
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/api/3/attachment/content/{$attachmentId}?redirect=false")
lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
IF ((loResp.StatusCode = 302) OR (loResp.StatusCode = 303) OR (loResp.StatusCode = 307)) THEN
    loLocation = CreateObject('Chilkat.StringBuilder')
    loLocation.SetString(loResp.GetHeaderField("Location"))
    IF (loLocation.StartsWith("https://",0) <> 1) THEN
        ? "Expected an HTTPS attachment redirect."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loLocation
        CANCEL
    ENDIF

    loDownload = CreateObject('Chilkat.Http')
    loDownload.RequireSslCertVerify = 1
    *  The signed URL authorizes this request; do not add Jira credentials.
    lnSuccess = loDownload.HttpNoBody("GET",loLocation.GetAsString(),loResp)
ENDIF

IF ((lnSuccess <> 1) OR (loResp.StatusCode <> 200)) THEN
    ? "Attachment download failed. HTTP " + STR(loResp.StatusCode)
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    RELEASE loLocation
    RELEASE loDownload
    CANCEL
ENDIF

lnSuccess = loResp.SaveBodyBinary(lcLocalPath)
IF (lnSuccess <> 1) THEN
    ? "Could not save the downloaded attachment."
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    RELEASE loLocation
    RELEASE loDownload
    CANCEL
ENDIF

? "Saved attachment to " + lcLocalPath

RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loLocation
RELEASE loDownload