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 C++ Downloads
#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>
#include <CkJsonObject.h>
void ChilkatSample(void)
{
bool success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
CkHttp http;
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");
const char *baseUrl = "https://your-domain.atlassian.net";
http.put_Accept("application/json");
CkStringBuilder url;
CkHttpResponse resp;
CkJsonObject reply;
const char *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) {
std::cout << "No HTTP response was received. Check connectivity and TLS settings." << "\r\n";
return;
}
if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
std::cout << "Request failed. HTTP " << resp.get_StatusCode() << "\r\n";
if (resp.get_StatusCode() == 429) {
std::cout << "Rate limited. Retry-After: " << resp.getHeaderField("Retry-After") << "\r\n";
}
// Inspect this response locally; it can contain private Jira data.
std::cout << resp.bodyStr() << "\r\n";
return;
}
success = reply.Load(resp.bodyStr());
if (success != true) {
std::cout << "Expected a JSON object in the response." << "\r\n";
return;
}
std::cout << "Issue: " << reply.stringOf("key") << "\r\n";
std::cout << "Summary: " << reply.stringOf("fields.summary") << "\r\n";
std::cout << "Status: " << reply.stringOf("fields.status.name") << "\r\n";
if (reply.IsNullOf("fields.assignee") == true) {
std::cout << "Unassigned" << "\r\n";
}
else {
std::cout << "Assignee: " << reply.stringOf("fields.assignee.displayName") << "\r\n";
}
if (reply.JsonTypeOf("fields.description") == 3) {
CkJsonObject description;
description = reply.ObjectOf("fields.description");
std::cout << "Description (ADF): " << description.emit() << "\r\n";
delete description;
}
}