Jira Cloud: Read a Customer Request and Add a Comment
See more Jira Examples
Read a Service Management customer request and its current status, retrieve every page of comments, and add a comment with explicit visibility. The code defaults to a public reply. Set publicReply to false only when the intended result is an internal note and the authenticated agent has permission.
Customers can add public comments only. An internal note is visible to authorized agents rather than the customer. The API returns only comments the caller may see. The request-comment body is a string; it is not the platform v3 ADF comment object. Running the example posts a real comment and may trigger notifications.
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 lcIssueKey
LOCAL lnPageStart
LOCAL lnPageMore
LOCAL loPageOffset
LOCAL lnPageCount
LOCAL lnPageIndex
LOCAL lnPublicReply
LOCAL loRequest
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')
lcIssueKey = "PROJECT-123"
loHttp.SetUrlVar("issueKey",lcIssueKey)
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/servicedeskapi/request/{$issueKey}")
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
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
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
CANCEL
ENDIF
? "Request: " + loReply.StringOf("issueKey")
? "Current status: " + loReply.StringOf("currentStatus.status")
lnPageStart = 0
lnPageMore = 1
loPageOffset = CreateObject('Chilkat.StringBuilder')
DO WHILE (lnPageMore = 1)
loPageOffset.Clear()
loPageOffset.AppendInt(lnPageStart)
loHttp.SetUrlVar("offset",loPageOffset.GetAsString())
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/servicedeskapi/request/{$issueKey}/comment?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 loPageOffset
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 loPageOffset
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 loPageOffset
CANCEL
ENDIF
IF (loReply.JsonTypeOf("values") <> 4) THEN
? "Expected an array: values"
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loPageOffset
CANCEL
ENDIF
lnPageCount = loReply.SizeOfArray("values")
lnPageIndex = 0
DO WHILE (lnPageIndex < lnPageCount)
loReply.I = lnPageIndex
? "Comment ID: " + loReply.StringOf("values[i].id") + " Public: " + STR(loReply.BoolOf("values[i].public"))
? loReply.StringOf("values[i].body")
lnPageIndex = lnPageIndex + 1
ENDDO
lnPageStart = lnPageStart + lnPageCount
lnPageMore = (loReply.BoolOf("isLastPage") <> 1)
IF ((lnPageMore = 1) AND (lnPageCount = 0)) THEN
? "Pagination made no progress; stopping."
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loPageOffset
CANCEL
ENDIF
ENDDO
lnPublicReply = 1
loRequest = CreateObject('Chilkat.JsonObject')
loRequest.UpdateString("body","An update on this request.")
loRequest.UpdateBool("public",lnPublicReply)
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/servicedeskapi/request/{$issueKey}/comment")
lnSuccess = loHttp.HttpJson("POST",loUrl.GetAsString(),loRequest,"application/json",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 loPageOffset
RELEASE loRequest
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 loPageOffset
RELEASE loRequest
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 loPageOffset
RELEASE loRequest
CANCEL
ENDIF
? "Created comment ID: " + loReply.StringOf("id") + " Public: " + STR(loReply.BoolOf("public"))
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loPageOffset
RELEASE loRequest