REST APIを利用して課題の説明が変更できない

Kentaro Sakanishi

REST APIを利用してJira Service Management(Cloud)で課題のステータス変更時に合わせてdescription(説明)の記載内容変更をしたいと考えています。
以下2点の質問があります。

1. 課題のステータス変更時に合わせてdescription(説明)の記載内容変更はできますでしょうか。
descriptionの内容変更をfieldsまたはupdateで設定すると、field descriptionを設定できないとエラーが表示され、設定できない状況です。

2. 上記1が変更不可の場合、課題のステータス変更時に合わせてコメントの記載内容変更はできますでしょうか。
以下の公開ドキュメントを確認した限りではコメントの記載内容変更はできそうに見受けられます。
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-post

R. Fujimura

コミュニティをご利用いただきありがとうございます。

課題のステータス変更(トランジション)時にdescription(説明)の内容を変更するには、以下の設定が必要でございます。

1. description(説明)フィールドを追加した画面を作成する (課題画面を設定する)  
2. 作成した画面を該当のワークフロートランジションに割り当てる
   • [プロジェクト設定] > [ワークフロー] > 対象のワークフローの編集画面を開き、トランジションを選択し[編集]
   • 1. で作成した画面を設定 
   • 

 

ご提示いただいたドキュメントに記載の通り、上記の様にトランジション画面が設定されており、その画面にて設定されているフィールドについてREST APIで更新いただくことが可能です。

• https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-post
  • (引用)Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.

以下、REST APIでdescriptionを"REST API TEST"と更新する際のRequest bodyサンプルでございます。

{
  "fields": {
        "description": {
            "version": 1,
            "type": "doc",
            "content": [
                {
                    "type": "paragraph",
                    "content": [
                        {
                            "type": "text",
                            "text": "REST API TEST"
                        }
                    ]
                }
            ]
        }
  },
  "transition": {
    "id": "11"
  }
}

transition idはワークフロー設定にて以下の様にご確認いただけます。

 

また、自動化を利用して課題のトランジション時に説明フィールドを更新することも可能ですので、ご検討いただけますと幸いです。

例:

• トリガー: 課題のトランジション時
• アクション: 課題の編集
  • 設定するフィールド: 説明

以上、よろしくお願いいたします。