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

Jira Cloud: Read a Customer Request and Add a Comment

See more Jira Examples

Read a Service Management customer request and its current status, retrieve every page of comments, and add a comment with explicit visibility. The code defaults to a public reply. Set publicReply to false only when the intended result is an internal note and the authenticated agent has permission.

Customers can add public comments only. An internal note is visible to authorized agents rather than the customer. The API returns only comments the caller may see. The request-comment body is a string; it is not the platform v3 ADF comment object. Running the example posts a real comment and may trigger notifications.

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);
    url.SetString(baseUrl);
    url.Append("/rest/servicedeskapi/request/{$issueKey}");
    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;
        }

    System.out.println("Request: " + reply.stringOf("issueKey"));
    System.out.println("Current status: " + reply.stringOf("currentStatus.status"));
    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/servicedeskapi/request/{$issueKey}/comment?start={$offset}&limit=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("values") != 4) {
            System.out.println("Expected an array: values");
            return;
            }

        int pageCount = reply.SizeOfArray("values");
        int pageIndex = 0;
        while ((pageIndex < pageCount)) {
            reply.put_I(pageIndex);
            System.out.println("Comment ID: " + reply.stringOf("values[i].id") + "  Public: " + reply.BoolOf("values[i].public"));
            System.out.println(reply.stringOf("values[i].body"));
            pageIndex = pageIndex+1;
            }

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

        }

    boolean publicReply = true;
    CkJsonObject request = new CkJsonObject();
    request.UpdateString("body","An update on this request.");
    request.UpdateBool("public",publicReply);
    url.SetString(baseUrl);
    url.Append("/rest/servicedeskapi/request/{$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") + "  Public: " + reply.BoolOf("public"));
  }
}