Jira Cloud: Get an Issue by Key
See more Jira Examples
Read an issue using its human-readable key and select the fields the application needs. An unassigned issue has a null assignee. The description is an ADF object, not an HTML or plain-text string; the example displays that JSON without assuming all ADF nodes are simple paragraphs.
Add a known custom-field ID to the fields parameter when needed. This example deliberately does not treat the embedded comments or worklogs as complete lists; their dedicated endpoints provide pagination.
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
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/api/3/issue/{$issueKey}?fields=summary,status,assignee,description,labels");
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("Issue: " + reply.stringOf("key"));
System.out.println("Summary: " + reply.stringOf("fields.summary"));
System.out.println("Status: " + reply.stringOf("fields.status.name"));
if (reply.IsNullOf("fields.assignee") == true) {
System.out.println("Unassigned");
}
else {
System.out.println("Assignee: " + reply.stringOf("fields.assignee.displayName"));
}
if (reply.JsonTypeOf("fields.description") == 3) {
CkJsonObject description = new CkJsonObject();
description = reply.ObjectOf("fields.description");
System.out.println("Description (ADF): " + description.emit());
}
}
}