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 Visual FoxPro Downloads
LOCAL lnSuccess
LOCAL loHttp
LOCAL lcBaseUrl
LOCAL loUrl
LOCAL loResp
LOCAL loReply
LOCAL lcIssueTypeName
LOCAL lcIssueTypeId
LOCAL lnMatches
LOCAL lnTypesStart
LOCAL lnTypesMore
LOCAL loTypesOffset
LOCAL lnTypesCount
LOCAL lnTypesIndex
LOCAL lnFieldsStart
LOCAL lnFieldsMore
LOCAL loFieldsOffset
LOCAL lnFieldsCount
LOCAL lnFieldsIndex
lnSuccess = 0
* Assumes Chilkat is unlocked. See Global Unlock Sample.
loHttp = CreateObject('Chilkat.Http')
loHttp.RequireSslCertVerify = 1
loHttp.BasicAuth = 1
* Read these credentials from private application configuration.
loHttp.Login = "YOUR_ATLASSIAN_EMAIL"
loHttp.Password = "YOUR_API_TOKEN"
lcBaseUrl = "https://your-domain.atlassian.net"
loHttp.Accept = "application/json"
loUrl = CreateObject('Chilkat.StringBuilder')
loResp = CreateObject('Chilkat.HttpResponse')
loReply = CreateObject('Chilkat.JsonObject')
loHttp.SetUrlVar("projectKey","PROJECT")
lcIssueTypeName = "Task"
lcIssueTypeId = ""
lnMatches = 0
lnTypesStart = 0
lnTypesMore = 1
loTypesOffset = CreateObject('Chilkat.StringBuilder')
DO WHILE (lnTypesMore = 1)
loTypesOffset.Clear()
loTypesOffset.AppendInt(lnTypesStart)
loHttp.SetUrlVar("offset",loTypesOffset.GetAsString())
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/api/3/issue/createmeta/{$projectKey}/issuetypes?startAt={$offset}&maxResults=50")
lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
IF (loResp.StatusCode = 0) THEN
? "No HTTP response was received. Check connectivity and TLS settings."
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
CANCEL
ENDIF
IF ((lnSuccess <> 1) OR (loResp.StatusCode < 200) OR (loResp.StatusCode >= 300)) THEN
? "Request failed. HTTP " + STR(loResp.StatusCode)
IF (loResp.StatusCode = 429) THEN
? "Rate limited. Retry-After: " + loResp.GetHeaderField("Retry-After")
ENDIF
* Inspect this response locally; it can contain private Jira data.
? loResp.BodyStr
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
CANCEL
ENDIF
lnSuccess = loReply.Load(loResp.BodyStr)
IF (lnSuccess <> 1) THEN
? "Expected a JSON object in the response."
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
CANCEL
ENDIF
IF (loReply.JsonTypeOf("issueTypes") <> 4) THEN
? "Expected an array: issueTypes"
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
CANCEL
ENDIF
lnTypesCount = loReply.SizeOfArray("issueTypes")
lnTypesIndex = 0
DO WHILE (lnTypesIndex < lnTypesCount)
loReply.I = lnTypesIndex
? loReply.StringOf("issueTypes[i].name") + " ID: " + loReply.StringOf("issueTypes[i].id")
IF (loReply.StringOfEquals("issueTypes[i].name",lcIssueTypeName,1) = 1) THEN
lcIssueTypeId = loReply.StringOf("issueTypes[i].id")
lnMatches = lnMatches + 1
ENDIF
lnTypesIndex = lnTypesIndex + 1
ENDDO
lnTypesStart = lnTypesStart + lnTypesCount
lnTypesMore = (lnTypesStart < loReply.IntOf("total"))
IF ((lnTypesMore = 1) AND (lnTypesCount = 0)) THEN
? "Pagination made no progress; stopping."
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
CANCEL
ENDIF
ENDDO
IF (lnMatches <> 1) THEN
? "Select one unambiguous issue type from the returned list."
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
CANCEL
ENDIF
loHttp.SetUrlVar("issueTypeId",lcIssueTypeId)
lnFieldsStart = 0
lnFieldsMore = 1
loFieldsOffset = CreateObject('Chilkat.StringBuilder')
DO WHILE (lnFieldsMore = 1)
loFieldsOffset.Clear()
loFieldsOffset.AppendInt(lnFieldsStart)
loHttp.SetUrlVar("offset",loFieldsOffset.GetAsString())
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/api/3/issue/createmeta/{$projectKey}/issuetypes/{$issueTypeId}?startAt={$offset}&maxResults=50")
lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
IF (loResp.StatusCode = 0) THEN
? "No HTTP response was received. Check connectivity and TLS settings."
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
RELEASE loFieldsOffset
CANCEL
ENDIF
IF ((lnSuccess <> 1) OR (loResp.StatusCode < 200) OR (loResp.StatusCode >= 300)) THEN
? "Request failed. HTTP " + STR(loResp.StatusCode)
IF (loResp.StatusCode = 429) THEN
? "Rate limited. Retry-After: " + loResp.GetHeaderField("Retry-After")
ENDIF
* Inspect this response locally; it can contain private Jira data.
? loResp.BodyStr
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
RELEASE loFieldsOffset
CANCEL
ENDIF
lnSuccess = loReply.Load(loResp.BodyStr)
IF (lnSuccess <> 1) THEN
? "Expected a JSON object in the response."
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
RELEASE loFieldsOffset
CANCEL
ENDIF
IF (loReply.JsonTypeOf("fields") <> 4) THEN
? "Expected an array: fields"
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
RELEASE loFieldsOffset
CANCEL
ENDIF
* Full metadata includes field schemas and allowed values.
? loReply.Emit()
lnFieldsCount = loReply.SizeOfArray("fields")
lnFieldsIndex = 0
DO WHILE (lnFieldsIndex < lnFieldsCount)
loReply.I = lnFieldsIndex
? loReply.StringOf("fields[i].fieldId") + " " + loReply.StringOf("fields[i].name") + " Required: " + STR(loReply.BoolOf("fields[i].required"))
lnFieldsIndex = lnFieldsIndex + 1
ENDDO
lnFieldsStart = lnFieldsStart + lnFieldsCount
lnFieldsMore = (lnFieldsStart < loReply.IntOf("total"))
IF ((lnFieldsMore = 1) AND (lnFieldsCount = 0)) THEN
? "Pagination made no progress; stopping."
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
RELEASE loFieldsOffset
CANCEL
ENDIF
ENDDO
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loTypesOffset
RELEASE loFieldsOffset