Uploaded image for project: 'Jira Service Management Data Center'
  1. Jira Service Management Data Center
  2. JSDSERVER-5034

Transition and add internal comment via REST API

XMLWordPrintable

    • 4
    • 4
    • We collect Jira Service Desk feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      NOTE: This suggestion is for Jira Service Management Server/Data Center. Using Jira Service Management Cloud? See the corresponding suggestion.

      Summary

      It's possible to transition a request via REST API and also to add an internal comment via REST API.

      However, it's not possible to transition and add an internal comment in the same call

      Suggestion

      Make it possible to transition and add an internal comment in the same REST API call

            [JSDSERVER-5034] Transition and add internal comment via REST API

            SET Analytics Bot made changes -
            UIS Original: 7 New: 4
            SET Analytics Bot made changes -
            Support reference count Original: 2 New: 4
            SET Analytics Bot made changes -
            UIS Original: 9 New: 7
            SET Analytics Bot made changes -
            UIS Original: 11 New: 9
            SET Analytics Bot made changes -
            UIS Original: 6 New: 11
            SET Analytics Bot made changes -
            UIS Original: 3 New: 6

            Ahmed Hisham added a comment -

            Below worked for me to transition and add internal comment

            function Add-InternalComment {
                param (
                    [string]$IssueKey,
                    [string]$Comment,
                    [string]$TransitionId = "181"  # Default transition ID
                )

                # Define the URL for the transitions endpoint
                $transitionUrl = "https://xxxxx.atlassian.net/rest/api/2/issue/$IssueKey/transitions"

                # Get the authentication headers
                $headers = Get-JiraAuthHeader

                # Prepare the body for the transition request
                $body = @{
                    update = @{
                        comment = @(
                            @{
                                add = @{
                                    body = $Comment
                                    properties = @(
                                        @{
                                            key = "sd.public.comment"
                                            value = @

            {                                     internal = $true                                 }

                                        }
                                    )
                                }
                            }
                        )
                    }
                    transition = @

            {             id = $TransitionId         }

                } | ConvertTo-Json -Depth 10 -Compress

                try

            {         # Perform the transition and add the internal comment         Write-Host "Transitioning issue $IssueKey and adding an internal comment."         Invoke-RestMethod -Uri $transitionUrl -Method Post -Headers $headers -Body $body         Write-Host "Successfully transitioned issue $IssueKey and added an internal comment."     }

            catch

            {         Write-Host "Error occurred while transitioning and commenting on issue $IssueKey : $_"         throw     }

            }

            Ahmed Hisham added a comment - Below worked for me to transition and add internal comment function Add-InternalComment {     param (         [string] $IssueKey,         [string] $Comment,         [string] $TransitionId = "181"  # Default transition ID     )     # Define the URL for the transitions endpoint     $transitionUrl = "https://xxxxx.atlassian.net/rest/api/2/issue/$IssueKey/transitions"     # Get the authentication headers     $headers = Get-JiraAuthHeader     # Prepare the body for the transition request     $body = @{         update = @{             comment = @(                 @{                     add = @{                         body = $Comment                         properties = @(                             @{                                 key = "sd.public.comment"                                 value = @ {                                     internal = $true                                 }                             }                         )                     }                 }             )         }         transition = @ {             id = $TransitionId         }     } | ConvertTo-Json -Depth 10 -Compress     try {         # Perform the transition and add the internal comment         Write-Host "Transitioning issue $IssueKey and adding an internal comment."         Invoke-RestMethod -Uri $transitionUrl -Method Post -Headers $headers -Body $body         Write-Host "Successfully transitioned issue $IssueKey and added an internal comment."     } catch {         Write-Host "Error occurred while transitioning and commenting on issue $IssueKey : $_"         throw     } }
            Marc Dacanay made changes -
            Labels New: ril
            Marc Dacanay made changes -
            Remote Link New: This issue links to "Internal ticket (Web Link)" [ 976744 ]
            SET Analytics Bot made changes -
            UIS Original: 2 New: 3

              Unassigned Unassigned
              ywoo Yit Wei
              Votes:
              35 Vote for this issue
              Watchers:
              20 Start watching this issue

                Created:
                Updated: