Sample code for 30+ languages & platforms
Visual FoxPro Requires Chilkat v11.0.0+

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 Visual FoxPro Downloads

Visual FoxPro
LOCAL lnSuccess
LOCAL loHttp
LOCAL lcBaseUrl
LOCAL loUrl
LOCAL loResp
LOCAL loReply
LOCAL lcProjectKey
LOCAL lcRequestTypeName
LOCAL lcServiceDeskId
LOCAL lcRequestTypeId
LOCAL lnDeskMatches
LOCAL lnTypeMatches
LOCAL lnDesksStart
LOCAL lnDesksMore
LOCAL loDesksOffset
LOCAL lnDesksCount
LOCAL lnDesksIndex
LOCAL lnTypesStart
LOCAL lnTypesMore
LOCAL loTypesOffset
LOCAL lnTypesCount
LOCAL lnTypesIndex
LOCAL i

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')
lcProjectKey = "SUPPORT"
lcRequestTypeName = "General request"
lcServiceDeskId = ""
lcRequestTypeId = ""
lnDeskMatches = 0
lnTypeMatches = 0
lnDesksStart = 0
lnDesksMore = 1
loDesksOffset = CreateObject('Chilkat.StringBuilder')
DO WHILE (lnDesksMore = 1)
    loDesksOffset.Clear()
    loDesksOffset.AppendInt(lnDesksStart)
    loHttp.SetUrlVar("offset",loDesksOffset.GetAsString())
    loUrl.SetString(lcBaseUrl)
    loUrl.Append("/rest/servicedeskapi/servicedesk?start={$offset}&limit=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 loDesksOffset
        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 loDesksOffset
        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 loDesksOffset
        CANCEL
    ENDIF

    IF (loReply.JsonTypeOf("values") <> 4) THEN
        ? "Expected an array: values"
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loDesksOffset
        CANCEL
    ENDIF

    lnDesksCount = loReply.SizeOfArray("values")
    lnDesksIndex = 0
    DO WHILE (lnDesksIndex < lnDesksCount)
        loReply.I = lnDesksIndex
        ? loReply.StringOf("values[i].projectKey") + "  " + loReply.StringOf("values[i].projectName") + "  Service desk ID: " + loReply.StringOf("values[i].id")
        IF (loReply.StringOfEquals("values[i].projectKey",lcProjectKey,1) = 1) THEN
            lcServiceDeskId = loReply.StringOf("values[i].id")
            lnDeskMatches = lnDeskMatches + 1
        ENDIF

        lnDesksIndex = lnDesksIndex + 1
    ENDDO
    lnDesksStart = lnDesksStart + lnDesksCount
    lnDesksMore = (loReply.BoolOf("isLastPage") <> 1)
    IF ((lnDesksMore = 1) AND (lnDesksCount = 0)) THEN
        ? "Pagination made no progress; stopping."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loDesksOffset
        CANCEL
    ENDIF

ENDDO
IF (lnDeskMatches <> 1) THEN
    ? "Expected exactly one matching service desk."
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    RELEASE loDesksOffset
    CANCEL
ENDIF

loHttp.SetUrlVar("serviceDeskId",lcServiceDeskId)
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/servicedeskapi/servicedesk/{$serviceDeskId}/requesttype?start={$offset}&limit=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 loDesksOffset
        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 loDesksOffset
        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 loDesksOffset
        RELEASE loTypesOffset
        CANCEL
    ENDIF

    IF (loReply.JsonTypeOf("values") <> 4) THEN
        ? "Expected an array: values"
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loDesksOffset
        RELEASE loTypesOffset
        CANCEL
    ENDIF

    lnTypesCount = loReply.SizeOfArray("values")
    lnTypesIndex = 0
    DO WHILE (lnTypesIndex < lnTypesCount)
        loReply.I = lnTypesIndex
        ? "Request type: " + loReply.StringOf("values[i].name") + "  ID: " + loReply.StringOf("values[i].id")
        IF (loReply.StringOfEquals("values[i].name",lcRequestTypeName,1) = 1) THEN
            lcRequestTypeId = loReply.StringOf("values[i].id")
            lnTypeMatches = lnTypeMatches + 1
        ENDIF

        lnTypesIndex = lnTypesIndex + 1
    ENDDO
    lnTypesStart = lnTypesStart + lnTypesCount
    lnTypesMore = (loReply.BoolOf("isLastPage") <> 1)
    IF ((lnTypesMore = 1) AND (lnTypesCount = 0)) THEN
        ? "Pagination made no progress; stopping."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loDesksOffset
        RELEASE loTypesOffset
        CANCEL
    ENDIF

ENDDO
IF (lnTypeMatches <> 1) THEN
    ? "Expected exactly one matching request type."
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    RELEASE loDesksOffset
    RELEASE loTypesOffset
    CANCEL
ENDIF

loHttp.SetUrlVar("requestTypeId",lcRequestTypeId)
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/servicedeskapi/servicedesk/{$serviceDeskId}/requesttype/{$requestTypeId}/field")
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 loDesksOffset
    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 loDesksOffset
    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 loDesksOffset
    RELEASE loTypesOffset
    CANCEL
ENDIF

IF (loReply.JsonTypeOf("requestTypeFields") <> 4) THEN
    ? "Expected an array: requestTypeFields"
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    RELEASE loDesksOffset
    RELEASE loTypesOffset
    CANCEL
ENDIF

i = 0
DO WHILE (i < loReply.SizeOfArray("requestTypeFields"))
    loReply.I = i
    ? loReply.StringOf("requestTypeFields[i].fieldId") + "  " + loReply.StringOf("requestTypeFields[i].name") + "  Required: " + STR(loReply.BoolOf("requestTypeFields[i].required"))
    i = i + 1
ENDDO
*  Includes validValues and field schemas for constructing the request.
? loReply.Emit()
? "Service desk ID: " + lcServiceDeskId + "  Request type ID: " + lcRequestTypeId

RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loDesksOffset
RELEASE loTypesOffset