Jira Cloud: Discover Service Desks and Request Types
See more Jira Examples
List accessible service desks, find one by its project key, list its request types, and retrieve the required fields for a request type selected by name. Use the returned service desk ID and request type ID in the customer-request creation example.
Request types are portal-facing forms and are not interchangeable with Jira issue types. Their fields, allowed values, and required flags can differ from the platform create-issue metadata. Access depends on the account's customer or agent role. OAuth integrations need the Service Management scopes documented for these operations.
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 projectKey = "SUPPORT";
String requestTypeName = "General request";
String serviceDeskId = "";
String requestTypeId = "";
int deskMatches = 0;
int typeMatches = 0;
int desksStart = 0;
boolean desksMore = true;
CkStringBuilder desksOffset = new CkStringBuilder();
while ((desksMore == true)) {
desksOffset.Clear();
desksOffset.AppendInt(desksStart);
http.SetUrlVar("offset",desksOffset.getAsString());
url.SetString(baseUrl);
url.Append("/rest/servicedeskapi/servicedesk?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 desksCount = reply.SizeOfArray("values");
int desksIndex = 0;
while ((desksIndex < desksCount)) {
reply.put_I(desksIndex);
System.out.println(reply.stringOf("values[i].projectKey") + " " + reply.stringOf("values[i].projectName") + " Service desk ID: " + reply.stringOf("values[i].id"));
if (reply.StringOfEquals("values[i].projectKey",projectKey,true) == true) {
serviceDeskId = reply.stringOf("values[i].id");
deskMatches = deskMatches+1;
}
desksIndex = desksIndex+1;
}
desksStart = desksStart+desksCount;
desksMore = (reply.BoolOf("isLastPage") != true);
if ((desksMore == true) && (desksCount == 0)) {
System.out.println("Pagination made no progress; stopping.");
return;
}
}
if (deskMatches != 1) {
System.out.println("Expected exactly one matching service desk.");
return;
}
http.SetUrlVar("serviceDeskId",serviceDeskId);
int typesStart = 0;
boolean typesMore = true;
CkStringBuilder typesOffset = new CkStringBuilder();
while ((typesMore == true)) {
typesOffset.Clear();
typesOffset.AppendInt(typesStart);
http.SetUrlVar("offset",typesOffset.getAsString());
url.SetString(baseUrl);
url.Append("/rest/servicedeskapi/servicedesk/{$serviceDeskId}/requesttype?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 typesCount = reply.SizeOfArray("values");
int typesIndex = 0;
while ((typesIndex < typesCount)) {
reply.put_I(typesIndex);
System.out.println("Request type: " + reply.stringOf("values[i].name") + " ID: " + reply.stringOf("values[i].id"));
if (reply.StringOfEquals("values[i].name",requestTypeName,true) == true) {
requestTypeId = reply.stringOf("values[i].id");
typeMatches = typeMatches+1;
}
typesIndex = typesIndex+1;
}
typesStart = typesStart+typesCount;
typesMore = (reply.BoolOf("isLastPage") != true);
if ((typesMore == true) && (typesCount == 0)) {
System.out.println("Pagination made no progress; stopping.");
return;
}
}
if (typeMatches != 1) {
System.out.println("Expected exactly one matching request type.");
return;
}
http.SetUrlVar("requestTypeId",requestTypeId);
url.SetString(baseUrl);
url.Append("/rest/servicedeskapi/servicedesk/{$serviceDeskId}/requesttype/{$requestTypeId}/field");
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("requestTypeFields") != 4) {
System.out.println("Expected an array: requestTypeFields");
return;
}
int i = 0;
while ((i < reply.SizeOfArray("requestTypeFields"))) {
reply.put_I(i);
System.out.println(reply.stringOf("requestTypeFields[i].fieldId") + " " + reply.stringOf("requestTypeFields[i].name") + " Required: " + reply.BoolOf("requestTypeFields[i].required"));
i = i+1;
}
// Includes validValues and field schemas for constructing the request.
System.out.println(reply.emit());
System.out.println("Service desk ID: " + serviceDeskId + " Request type ID: " + requestTypeId);
}
}