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

CkJava
import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

    //  Assumes Chilkat is unlocked. See Global Unlock Sample.

    CkHttp http = new 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");
    String baseUrl = "https://your-domain.atlassian.net";
    http.put_Accept("application/json");
    CkStringBuilder url = new CkStringBuilder();
    CkHttpResponse resp = new CkHttpResponse();
    CkJsonObject reply = new CkJsonObject();
    String issueKey = "PROJECT-123";
    http.SetUrlVar("issueKey",issueKey);
    CkJsonObject request = new 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) {
        System.out.println("No HTTP response was received. Check connectivity and TLS settings.");
        return;
        }

    if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
        System.out.println("Request failed. HTTP " + resp.get_StatusCode());
        if (resp.get_StatusCode() == 429) {
            System.out.println("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"));
            }

        //  Inspect this response locally; it can contain private Jira data.
        System.out.println(resp.bodyStr());
        return;
        }

    success = reply.Load(resp.bodyStr());
    if (success != true) {
        System.out.println("Expected a JSON object in the response.");
        return;
        }

    System.out.println("Created comment ID: " + reply.stringOf("id"));
    CkJsonObject body = new CkJsonObject();
    int pageStart = 0;
    boolean pageMore = true;
    CkStringBuilder pageOffset = new 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) {
            System.out.println("No HTTP response was received. Check connectivity and TLS settings.");
            return;
            }

        if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
            System.out.println("Request failed. HTTP " + resp.get_StatusCode());
            if (resp.get_StatusCode() == 429) {
                System.out.println("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"));
                }

            //  Inspect this response locally; it can contain private Jira data.
            System.out.println(resp.bodyStr());
            return;
            }

        success = reply.Load(resp.bodyStr());
        if (success != true) {
            System.out.println("Expected a JSON object in the response.");
            return;
            }

        if (reply.JsonTypeOf("comments") != 4) {
            System.out.println("Expected an array: comments");
            return;
            }

        int pageCount = reply.SizeOfArray("comments");
        int pageIndex = 0;
        while ((pageIndex < pageCount)) {
            reply.put_I(pageIndex);
            System.out.println("Comment " + reply.stringOf("comments[i].id") + " by " + reply.stringOf("comments[i].author.displayName"));
            body = reply.ObjectOf("comments[i].body");
            if (reply.get_LastMethodSuccess() == true) {
                System.out.println(body.emit());

                }

            pageIndex = pageIndex+1;
            }

        pageStart = pageStart+pageCount;
        pageMore = (pageStart < reply.IntOf("total"));
        if ((pageMore == true) && (pageCount == 0)) {
            System.out.println("Pagination made no progress; stopping.");
            return;
            }

        }
  }
}