Jira Cloud: Discover Issue Types and Required Fields
See more Jira Examples
List a project's available issue types, then retrieve the creation fields for the type selected by name. Required fields and allowed values depend on project configuration. Inspect the returned field metadata before adapting the create-issue example. The current project-scoped metadata endpoints replace the deprecated general create-metadata endpoint.
The code lists field IDs and required flags, plus the full field metadata for each page (including schemas and allowed values). Field names are display labels; submit the returned field ID, such as customfield_10042. A field can be absent from the create screen or require a project-specific value.
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 CkPython Downloads
import sys
import chilkat
success = False
# Assumes Chilkat is unlocked. See Global Unlock Sample.
http = chilkat.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")
baseUrl = "https://your-domain.atlassian.net"
http.put_Accept("application/json")
url = chilkat.CkStringBuilder()
resp = chilkat.CkHttpResponse()
reply = chilkat.CkJsonObject()
http.SetUrlVar("projectKey","PROJECT")
issueTypeName = "Task"
issueTypeId = ""
matches = 0
typesStart = 0
typesMore = True
typesOffset = chilkat.CkStringBuilder()
while (typesMore == True) :
typesOffset.Clear()
typesOffset.AppendInt(typesStart)
http.SetUrlVar("offset",typesOffset.getAsString())
url.SetString(baseUrl)
url.Append("/rest/api/3/issue/createmeta/{$projectKey}/issuetypes?startAt={$offset}&maxResults=50")
success = http.HttpNoBody("GET",url.getAsString(),resp)
if (resp.get_StatusCode() == 0):
print("No HTTP response was received. Check connectivity and TLS settings.")
sys.exit()
if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
print("Request failed. HTTP " + str(resp.get_StatusCode()))
if (resp.get_StatusCode() == 429):
print("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"))
# Inspect this response locally; it can contain private Jira data.
print(resp.bodyStr())
sys.exit()
success = reply.Load(resp.bodyStr())
if (success != True):
print("Expected a JSON object in the response.")
sys.exit()
if (reply.JsonTypeOf("issueTypes") != 4):
print("Expected an array: issueTypes")
sys.exit()
typesCount = reply.SizeOfArray("issueTypes")
typesIndex = 0
while (typesIndex < typesCount) :
reply.put_I(typesIndex)
print(reply.stringOf("issueTypes[i].name") + " ID: " + reply.stringOf("issueTypes[i].id"))
if (reply.StringOfEquals("issueTypes[i].name",issueTypeName,True) == True):
issueTypeId = reply.stringOf("issueTypes[i].id")
matches = matches + 1
typesIndex = typesIndex + 1
typesStart = typesStart + typesCount
typesMore = (typesStart < reply.IntOf("total"))
if ((typesMore == True) and (typesCount == 0)):
print("Pagination made no progress; stopping.")
sys.exit()
if (matches != 1):
print("Select one unambiguous issue type from the returned list.")
sys.exit()
http.SetUrlVar("issueTypeId",issueTypeId)
fieldsStart = 0
fieldsMore = True
fieldsOffset = chilkat.CkStringBuilder()
while (fieldsMore == True) :
fieldsOffset.Clear()
fieldsOffset.AppendInt(fieldsStart)
http.SetUrlVar("offset",fieldsOffset.getAsString())
url.SetString(baseUrl)
url.Append("/rest/api/3/issue/createmeta/{$projectKey}/issuetypes/{$issueTypeId}?startAt={$offset}&maxResults=50")
success = http.HttpNoBody("GET",url.getAsString(),resp)
if (resp.get_StatusCode() == 0):
print("No HTTP response was received. Check connectivity and TLS settings.")
sys.exit()
if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
print("Request failed. HTTP " + str(resp.get_StatusCode()))
if (resp.get_StatusCode() == 429):
print("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"))
# Inspect this response locally; it can contain private Jira data.
print(resp.bodyStr())
sys.exit()
success = reply.Load(resp.bodyStr())
if (success != True):
print("Expected a JSON object in the response.")
sys.exit()
if (reply.JsonTypeOf("fields") != 4):
print("Expected an array: fields")
sys.exit()
# Full metadata includes field schemas and allowed values.
print(reply.emit())
fieldsCount = reply.SizeOfArray("fields")
fieldsIndex = 0
while (fieldsIndex < fieldsCount) :
reply.put_I(fieldsIndex)
print(reply.stringOf("fields[i].fieldId") + " " + reply.stringOf("fields[i].name") + " Required: " + str(reply.BoolOf("fields[i].required")))
fieldsIndex = fieldsIndex + 1
fieldsStart = fieldsStart + fieldsCount
fieldsMore = (fieldsStart < reply.IntOf("total"))
if ((fieldsMore == True) and (fieldsCount == 0)):
print("Pagination made no progress; stopping.")
sys.exit()