Sample code for 30+ languages & platforms
CkPython 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 CkPython Downloads

CkPython
import sys
import chilkat

success = False

#  Assumes Chilkat is unlocked. See Global Unlock Sample.

http = chilkat.CkHttp()
http.put_RequireSslCertVerify(True)
http.put_BasicAuth(True)
#  Read these credentials from private application configuration.
http.put_Login("YOUR_ATLASSIAN_EMAIL")
http.put_Password("YOUR_API_TOKEN")
baseUrl = "https://your-domain.atlassian.net"
http.put_Accept("application/json")
url = chilkat.CkStringBuilder()
resp = chilkat.CkHttpResponse()
reply = chilkat.CkJsonObject()
issueKey = "PROJECT-123"
http.SetUrlVar("issueKey",issueKey)
request = chilkat.CkJsonObject()
#  Jira v3 rich text is an Atlassian Document Format (ADF) document.
request.UpdateString("body.type","doc")
request.UpdateInt("body.version",1)
request.UpdateString("body.content[0].type","paragraph")
request.UpdateString("body.content[0].content[0].type","text")
request.UpdateString("body.content[0].content[0].text","A comment added through the REST API.")
url.SetString(baseUrl)
url.Append("/rest/api/3/issue/{$issueKey}/comment")
success = http.HttpJson("POST",url.getAsString(),request,"application/json",resp)
if (resp.get_StatusCode() == 0):
    print("No HTTP response was received. Check connectivity and TLS settings.")
    sys.exit()

if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
    print("Request failed. HTTP " + str(resp.get_StatusCode()))
    if (resp.get_StatusCode() == 429):
        print("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"))

    #  Inspect this response locally; it can contain private Jira data.
    print(resp.bodyStr())
    sys.exit()

success = reply.Load(resp.bodyStr())
if (success != True):
    print("Expected a JSON object in the response.")
    sys.exit()

print("Created comment ID: " + reply.stringOf("id"))
body = chilkat.CkJsonObject()
pageStart = 0
pageMore = True
pageOffset = chilkat.CkStringBuilder()
while (pageMore == True) :
    pageOffset.Clear()
    pageOffset.AppendInt(pageStart)
    http.SetUrlVar("offset",pageOffset.getAsString())
    url.SetString(baseUrl)
    url.Append("/rest/api/3/issue/{$issueKey}/comment?startAt={$offset}&maxResults=50")
    success = http.HttpNoBody("GET",url.getAsString(),resp)
    if (resp.get_StatusCode() == 0):
        print("No HTTP response was received. Check connectivity and TLS settings.")
        sys.exit()

    if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
        print("Request failed. HTTP " + str(resp.get_StatusCode()))
        if (resp.get_StatusCode() == 429):
            print("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"))

        #  Inspect this response locally; it can contain private Jira data.
        print(resp.bodyStr())
        sys.exit()

    success = reply.Load(resp.bodyStr())
    if (success != True):
        print("Expected a JSON object in the response.")
        sys.exit()

    if (reply.JsonTypeOf("comments") != 4):
        print("Expected an array: comments")
        sys.exit()

    pageCount = reply.SizeOfArray("comments")
    pageIndex = 0
    while (pageIndex < pageCount) :
        reply.put_I(pageIndex)
        print("Comment " + reply.stringOf("comments[i].id") + " by " + reply.stringOf("comments[i].author.displayName"))
        # body is a CkJsonObject
        body = reply.ObjectOf("comments[i].body")
        if (reply.get_LastMethodSuccess() == True):
            print(body.emit())

        pageIndex = pageIndex + 1

    pageStart = pageStart + pageCount
    pageMore = (pageStart < reply.IntOf("total"))
    if ((pageMore == True) and (pageCount == 0)):
        print("Pagination made no progress; stopping.")
        sys.exit()