DataFlex Jira - Issues: Update a Comment

Back to Index

Updates a comment. This example updates comment (id=10019) for the issue with key = "SCRUM-15".

Documentation: https://developers.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-comment-id-put

CURL Command

curl --request PUT --user jira@example.com:JIRA_API_TOKEN \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "body": "ABC Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
      "visibility": {
        "type": "role",
        "value": "Administrators"
      }
    }' \
  --url 'https://your-domain.atlassian.net/rest/api/2/issue/SCRUM-15/comment/10019'

DataFlex Example

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoRest
    Boolean iSuccess
    Boolean iBTls
    Integer iPort
    Boolean iBAutoReconnect
    Handle hoJson
    Variant vSbRequestBody
    Handle hoSbRequestBody
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Integer iRespStatusCode
Response    Handle hoJsonResponse
    String sSelf
    String sId
    String sAuthorSelf
    String sAuthorName
    String sAuthorKey
    String sAuthorAccountId
    String sAuthorEmailAddress
    String sAuthorAvatarUrls48x48
    String sAuthorAvatarUrls24x24
    String sAuthorAvatarUrls16x16
    String sAuthorAvatarUrls32x32
    String sAuthorDisplayName
    Boolean iAuthorActive
    String sAuthorTimeZone
    String sBody
    String sUpdateAuthorSelf
    String sUpdateAuthorName
    String sUpdateAuthorKey
    String sUpdateAuthorAccountId
    String sUpdateAuthorEmailAddress
    String sUpdateAuthorAvatarUrls48x48
    String sUpdateAuthorAvatarUrls24x24
    String sUpdateAuthorAvatarUrls16x16
    String sUpdateAuthorAvatarUrls32x32
    String sUpdateAuthorDisplayName
    Boolean iUpdateAuthorActive
    String sUpdateAuthorTimeZone
    String sCreated
    String sUpdated
    String sVisibilityType
    String sVisibilityValue
    String sTemp1
    Integer iTemp1

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    //  URL: https://your-domain.atlassian.net/rest/api/2/issue/SCRUM-15/comment/10019
    Move True To iBTls
    Move 443 To iPort
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "your-domain.atlassian.net" iPort iBTls iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComConnectFailReason Of hoRest To iTemp1
        Showln "ConnectFailReason: " iTemp1
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComSetAuthBasic Of hoRest "jira@example.com" "JIRA_API_TOKEN" To iSuccess

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "body" "ABC Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper." To iSuccess
    Get ComUpdateString Of hoJson "visibility.type" "role" To iSuccess
    Get ComUpdateString Of hoJson "visibility.value" "Administrators" To iSuccess

    Get ComAddHeader Of hoRest "Content-Type" "application/json" To iSuccess
    Get ComAddHeader Of hoRest "Accept" "application/json" To iSuccess

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
    If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
        Send CreateComObject of hoSbRequestBody
    End
    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComFullRequestSb Of hoRest "PUT" "/rest/api/2/issue/SCRUM-15/comment/10019" vSbRequestBody vSbResponseBody To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComResponseStatusCode Of hoRest To iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Status Code = " iRespStatusCode
        Showln "Response Header:"
        Get ComResponseHeader Of hoRest To sTemp1
        Showln sTemp1
        Showln "Response Body:"
        Get ComGetAsString Of hoSbResponseBody To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonResponse
    If (Not(IsComObjectCreated(hoJsonResponse))) Begin
        Send CreateComObject of hoJsonResponse
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJsonResponse vSbResponseBody To iSuccess

    Get ComStringOf Of hoJsonResponse "self" To sSelf
    Get ComStringOf Of hoJsonResponse "id" To sId
    Get ComStringOf Of hoJsonResponse "author.self" To sAuthorSelf
    Get ComStringOf Of hoJsonResponse "author.name" To sAuthorName
    Get ComStringOf Of hoJsonResponse "author.key" To sAuthorKey
    Get ComStringOf Of hoJsonResponse "author.accountId" To sAuthorAccountId
    Get ComStringOf Of hoJsonResponse "author.emailAddress" To sAuthorEmailAddress
    Get ComStringOf Of hoJsonResponse "author.avatarUrls.48x48" To sAuthorAvatarUrls48x48
    Get ComStringOf Of hoJsonResponse "author.avatarUrls.24x24" To sAuthorAvatarUrls24x24
    Get ComStringOf Of hoJsonResponse "author.avatarUrls.16x16" To sAuthorAvatarUrls16x16
    Get ComStringOf Of hoJsonResponse "author.avatarUrls.32x32" To sAuthorAvatarUrls32x32
    Get ComStringOf Of hoJsonResponse "author.displayName" To sAuthorDisplayName
    Get ComBoolOf Of hoJsonResponse "author.active" To iAuthorActive
    Get ComStringOf Of hoJsonResponse "author.timeZone" To sAuthorTimeZone
    Get ComStringOf Of hoJsonResponse "body" To sBody
    Get ComStringOf Of hoJsonResponse "updateAuthor.self" To sUpdateAuthorSelf
    Get ComStringOf Of hoJsonResponse "updateAuthor.name" To sUpdateAuthorName
    Get ComStringOf Of hoJsonResponse "updateAuthor.key" To sUpdateAuthorKey
    Get ComStringOf Of hoJsonResponse "updateAuthor.accountId" To sUpdateAuthorAccountId
    Get ComStringOf Of hoJsonResponse "updateAuthor.emailAddress" To sUpdateAuthorEmailAddress
    Get ComStringOf Of hoJsonResponse "updateAuthor.avatarUrls.48x48" To sUpdateAuthorAvatarUrls48x48
    Get ComStringOf Of hoJsonResponse "updateAuthor.avatarUrls.24x24" To sUpdateAuthorAvatarUrls24x24
    Get ComStringOf Of hoJsonResponse "updateAuthor.avatarUrls.16x16" To sUpdateAuthorAvatarUrls16x16
    Get ComStringOf Of hoJsonResponse "updateAuthor.avatarUrls.32x32" To sUpdateAuthorAvatarUrls32x32
    Get ComStringOf Of hoJsonResponse "updateAuthor.displayName" To sUpdateAuthorDisplayName
    Get ComBoolOf Of hoJsonResponse "updateAuthor.active" To iUpdateAuthorActive
    Get ComStringOf Of hoJsonResponse "updateAuthor.timeZone" To sUpdateAuthorTimeZone
    Get ComStringOf Of hoJsonResponse "created" To sCreated
    Get ComStringOf Of hoJsonResponse "updated" To sUpdated
    Get ComStringOf Of hoJsonResponse "visibility.type" To sVisibilityType
    Get ComStringOf Of hoJsonResponse "visibility.value" To sVisibilityValue


End_Procedure

Sample JSON Response Body

{
  "self": "https://chilkat.atlassian.net/rest/api/2/issue/10014/comment/10019",
  "id": "10019",
  "author": {
    "self": "https://chilkat.atlassian.net/rest/api/2/user?username=admin",
    "name": "admin",
    "key": "admin",
    "accountId": "557058:be8b47b5-3bc0-43f6-b6b2-2cca0de12204",
    "emailAddress": "admin@chilkatsoft.com",
    "avatarUrls": {
      "48x48": "https://avatar-cdn.atlassian.com/16d54dcc6d4bef86fd7ee62a7cf6334a?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F16d54dcc6d4bef86fd7ee62a7cf6334a%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue",
      "24x24": "https://avatar-cdn.atlassian.com/16d54dcc6d4bef86fd7ee62a7cf6334a?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F16d54dcc6d4bef86fd7ee62a7cf6334a%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
      "16x16": "https://avatar-cdn.atlassian.com/16d54dcc6d4bef86fd7ee62a7cf6334a?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F16d54dcc6d4bef86fd7ee62a7cf6334a%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
      "32x32": "https://avatar-cdn.atlassian.com/16d54dcc6d4bef86fd7ee62a7cf6334a?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F16d54dcc6d4bef86fd7ee62a7cf6334a%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue"
    },
    "displayName": "Chilkat Admin",
    "active": true,
    "timeZone": "America/Chicago"
  },
  "body": "ABC Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
  "updateAuthor": {
    "self": "https://chilkat.atlassian.net/rest/api/2/user?username=admin",
    "name": "admin",
    "key": "admin",
    "accountId": "557058:be8b47b5-3bc0-43f6-b6b2-2cca0de12204",
    "emailAddress": "admin@chilkatsoft.com",
    "avatarUrls": {
      "48x48": "https://avatar-cdn.atlassian.com/16d54dcc6d4bef86fd7ee62a7cf6334a?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F16d54dcc6d4bef86fd7ee62a7cf6334a%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue",
      "24x24": "https://avatar-cdn.atlassian.com/16d54dcc6d4bef86fd7ee62a7cf6334a?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F16d54dcc6d4bef86fd7ee62a7cf6334a%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
      "16x16": "https://avatar-cdn.atlassian.com/16d54dcc6d4bef86fd7ee62a7cf6334a?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F16d54dcc6d4bef86fd7ee62a7cf6334a%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
      "32x32": "https://avatar-cdn.atlassian.com/16d54dcc6d4bef86fd7ee62a7cf6334a?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F16d54dcc6d4bef86fd7ee62a7cf6334a%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue"
    },
    "displayName": "Chilkat Admin",
    "active": true,
    "timeZone": "America/Chicago"
  },
  "created": "2018-04-14T10:14:41.741-0500",
  "updated": "2018-04-14T10:25:07.558-0500",
  "visibility": {
    "type": "role",
    "value": "Administrators"
  }
}