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

Jira Cloud: Search Issues with JQL

See more Jira Examples

Use enhanced JQL search to retrieve selected issue fields across every page. Sending JQL in a JSON POST body avoids URL-length and query-encoding problems. The current endpoint uses nextPageToken; do not substitute startAt or use the deprecated /rest/api/3/search endpoint.

Results include only issues visible to the account. Recent changes can take time to appear in search. If immediate read-after-write consistency is needed, use the endpoint's reconcileIssues option with the affected numeric issue IDs, or retrieve a known issue directly. A pagination token belongs to the same query and selected fields.

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();
    CkJsonObject request = new CkJsonObject();
    //  Bound the query to a project. Adapt the JQL to your permissions and needs.
    request.UpdateString("jql","project = PROJECT ORDER BY key");
    request.UpdateInt("maxResults",50);
    request.UpdateString("fields[0]","summary");
    request.UpdateString("fields[1]","status");
    request.UpdateString("fields[2]","assignee");
    String previousToken = "";
    String nextToken = "";
    boolean more = true;
    while ((more == true)) {
        url.SetString(baseUrl);
        url.Append("/rest/api/3/search/jql");
        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;
            }

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

        int count = reply.SizeOfArray("issues");
        int i = 0;
        while ((i < count)) {
            reply.put_I(i);
            System.out.println(reply.stringOf("issues[i].key") + "  " + reply.stringOf("issues[i].fields.summary") + "  " + reply.stringOf("issues[i].fields.status.name"));
            if (reply.IsNullOf("issues[i].fields.assignee") != true) {
                System.out.println("Assignee: " + reply.stringOf("issues[i].fields.assignee.displayName"));
                }

            i = i+1;
            }

        more = (reply.BoolOf("isLast") != true);
        if (more == true) {
            if ((reply.JsonTypeOf("nextPageToken") != 1) || (reply.StringOfEquals("nextPageToken","",true) == true)) {
                System.out.println("Missing value: nextPageToken");
                return;
                }

            nextToken = reply.stringOf("nextPageToken");
            if (nextToken == previousToken) {
                System.out.println("Repeated pagination token; stopping.");
                return;
                }

            previousToken = nextToken;
            request.UpdateString("nextPageToken",nextToken);
            }

        }
  }
}