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

Jira Cloud: Add and Read Issue Comments

See more Jira Examples

Add a comment using an ADF document and retrieve all pages of comments. Comment bodies are structured rich text; the example displays their JSON instead of assuming every comment contains a single text node. Re-running the example creates another comment.

This platform example adds an ordinary Jira comment without a group/role visibility restriction. For a Service Management customer reply or internal note, use the Service Management comment API, where visibility is explicit.

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 loRequest
LOCAL loBody
LOCAL lnPageStart
LOCAL lnPageMore
LOCAL loPageOffset
LOCAL lnPageCount
LOCAL lnPageIndex

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)
loRequest = CreateObject('Chilkat.JsonObject')
*  Jira v3 rich text is an Atlassian Document Format (ADF) document.
loRequest.UpdateString("body.type","doc")
loRequest.UpdateInt("body.version",1)
loRequest.UpdateString("body.content[0].type","paragraph")
loRequest.UpdateString("body.content[0].content[0].type","text")
loRequest.UpdateString("body.content[0].content[0].text","A comment added through the REST API.")
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/api/3/issue/{$issueKey}/comment")
lnSuccess = loHttp.HttpJson("POST",loUrl.GetAsString(),loRequest,"application/json",loResp)
IF (loResp.StatusCode = 0) THEN
    ? "No HTTP response was received. Check connectivity and TLS settings."
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    RELEASE loRequest
    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
    RELEASE loRequest
    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
    RELEASE loRequest
    CANCEL
ENDIF

? "Created comment ID: " + loReply.StringOf("id")
loBody = CreateObject('Chilkat.JsonObject')
lnPageStart = 0
lnPageMore = 1
loPageOffset = CreateObject('Chilkat.StringBuilder')
DO WHILE (lnPageMore = 1)
    loPageOffset.Clear()
    loPageOffset.AppendInt(lnPageStart)
    loHttp.SetUrlVar("offset",loPageOffset.GetAsString())
    loUrl.SetString(lcBaseUrl)
    loUrl.Append("/rest/api/3/issue/{$issueKey}/comment?startAt={$offset}&maxResults=50")
    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
        RELEASE loRequest
        RELEASE loBody
        RELEASE loPageOffset
        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
        RELEASE loRequest
        RELEASE loBody
        RELEASE loPageOffset
        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
        RELEASE loRequest
        RELEASE loBody
        RELEASE loPageOffset
        CANCEL
    ENDIF

    IF (loReply.JsonTypeOf("comments") <> 4) THEN
        ? "Expected an array: comments"
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loRequest
        RELEASE loBody
        RELEASE loPageOffset
        CANCEL
    ENDIF

    lnPageCount = loReply.SizeOfArray("comments")
    lnPageIndex = 0
    DO WHILE (lnPageIndex < lnPageCount)
        loReply.I = lnPageIndex
        ? "Comment " + loReply.StringOf("comments[i].id") + " by " + loReply.StringOf("comments[i].author.displayName")
        loBody = loReply.ObjectOf("comments[i].body")
        IF (loReply.LastMethodSuccess = 1) THEN
            ? loBody.Emit()
            RELEASE loBody
        ENDIF

        lnPageIndex = lnPageIndex + 1
    ENDDO
    lnPageStart = lnPageStart + lnPageCount
    lnPageMore = (lnPageStart < loReply.IntOf("total"))
    IF ((lnPageMore = 1) AND (lnPageCount = 0)) THEN
        ? "Pagination made no progress; stopping."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loRequest
        RELEASE loBody
        RELEASE loPageOffset
        CANCEL
    ENDIF

ENDDO

RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loRequest
RELEASE loBody
RELEASE loPageOffset