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 Unicode C++ Downloads
#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
bool success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
CkHttpW http;
http.put_RequireSslCertVerify(true);
http.put_BasicAuth(true);
// Read these credentials from private application configuration.
http.put_Login(L"YOUR_ATLASSIAN_EMAIL");
http.put_Password(L"YOUR_API_TOKEN");
const wchar_t *baseUrl = L"https://your-domain.atlassian.net";
http.put_Accept(L"application/json");
CkStringBuilderW url;
CkHttpResponseW resp;
CkJsonObjectW reply;
const wchar_t *issueKey = L"PROJECT-123";
http.SetUrlVar(L"issueKey",issueKey);
url.SetString(baseUrl);
url.Append(L"/rest/api/3/issue/{$issueKey}?fields=summary,status,assignee,description,labels");
success = http.HttpNoBody(L"GET",url.getAsString(),resp);
if (resp.get_StatusCode() == 0) {
wprintf(L"No HTTP response was received. Check connectivity and TLS settings.\n");
return;
}
if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
wprintf(L"Request failed. HTTP %d\n",resp.get_StatusCode());
if (resp.get_StatusCode() == 429) {
wprintf(L"Rate limited. Retry-After: %s\n",resp.getHeaderField(L"Retry-After"));
}
// Inspect this response locally; it can contain private Jira data.
wprintf(L"%s\n",resp.bodyStr());
return;
}
success = reply.Load(resp.bodyStr());
if (success != true) {
wprintf(L"Expected a JSON object in the response.\n");
return;
}
wprintf(L"Issue: %s\n",reply.stringOf(L"key"));
wprintf(L"Summary: %s\n",reply.stringOf(L"fields.summary"));
wprintf(L"Status: %s\n",reply.stringOf(L"fields.status.name"));
if (reply.IsNullOf(L"fields.assignee") == true) {
wprintf(L"Unassigned\n");
}
else {
wprintf(L"Assignee: %s\n",reply.stringOf(L"fields.assignee.displayName"));
}
if (reply.JsonTypeOf(L"fields.description") == 3) {
CkJsonObjectW description;
description = reply.ObjectOf(L"fields.description");
wprintf(L"Description (ADF): %s\n",description.emit());
delete description;
}
}