Jira課題の更新

既存のJira課題を更新します。

認証のセットアップについては、Jira issue actionsを参照してください。

入力	タイプ	説明	例
authToken	弦	必須。Basic認証用のBase64エンコードされた`email:API_Token`の文字列。シークレットとして提供する必要があります。APIトークンの作成と管理を参照してください。	`"${{ :secrets:jiraAuthToken }}"`
ドメイン	弦	必須。Jira Cloudインスタンスのドメイン（会社名）。ベースURL `your-domain.atlassian.net` の構築に使用されます。	`"mycompany"`
issueKey	弦	必須。更新するJira課題のキー。	`"PROJ-123"`
パラメーター	地図	オプション。Jira APIリクエスト用のオプションのURLクエリパラメーター。以下のパラメーターリファレンス表をご覧ください。	`{"notifyUsers": "false", "returnIssue": "true", "expand": "changelog,renderedFields"}`
フィールド	地図	オプション。サブフィールドとその値を指定する、更新する課題画面フィールドのマップです。簡単な単一サブフィールドの更新には、これを使用してください。ここに含まれるフィールドは、`update`に含めることはできません。許可された値を持つすべてのフィールドを取得するには、`GET /rest/api/3/issue/{issueKey}/editmeta`を使用してください。	`{"priority": {"name": "High"}, "labels": ["bug", "production"]}`
アップデート	地図	オプション。フィールド名のマップと、課題画面のフィールドに対して実行する操作のリスト。複数のサブフィールドまたはその他の操作が必要な場合に使用します。ここに含まれるフィールドは、`fields`にも含めることはできません。	`{"labels": [{"add": "critical"}, {"remove": "minor"}], "components": [{"set": [{"name": "Backend"}]}]}`
selectors	リスト	オプション。レスポンスから特定の値を抽出するための名前付き式のリスト。	`[{"name": "summary", "expression": ".responseBody.result.summary"}]`

パラメーターリファレンス

パラメータ	タイプ	説明	デフォルト
notifyUsers	ブール値	課題の更新に関する通知メールがすべてのウォッチャーに送信されるかどうか。通知を無効にするには、Jira管理者またはプロジェクト管理者の権限が必要です。ユーザーが必要な権限を持っていない場合、これは無視されます。	`true`
overrideScreenSecurity	ブール値	非表示フィールドを編集できるように画面セキュリティをオーバーライドするかどうか。Jira管理者グローバル権限を持つConnectおよびForgeアプリユーザーが利用できます。	`false`
overrideEditableFlag	ブール値	編集不可能なフィールドを編集できるように、画面セキュリティがオーバーライドされるかどうか。Administer Jiraグローバル権限を持つConnectおよびForgeアプリのユーザーが利用できます。	`false`
returnIssue	ブール値	レスポンスに、このリクエストで編集されたフィールドを持つ課題を、Get issue APIと同様にフォーマットして含めるかどうか。	`false`
expand	弦	`returnIssue`が`true`の場合にレスポンスで使用するGet issue APIのexpandパラメーター。

出力	タイプ	例
response	オブジェクト	更新に成功すると、ステータス204の空の本文が返されます。
success	ブール値	`success: true \| false`
errorMessage	弦	`{ "errorMessages": ["Can not update issue with invalid data"], "errors": { "summary": "Summary is required" } }`

ワークフローの例
name: update-jira-issues description: 'Updates a ticket summary and adds a new label' steps: - name: set_summary type: action action: jira.issue.update version: 1 inputs: authToken: ${{ :secrets:jiraAuthToken }} domain: mycompany issueKey: "PROJ-123" fields: summary: "Updated: Critical production error resolved" description: type: "doc" version: 1 content: - type: "paragraph" content: - type: "text" text: "Root cause identified and fix deployed to production" update: labels: - add: "resolved" - add: "production" parameters: returnIssue: "true" next: end

ワークフローの例

name: update-jira-issues
description: 'Updates a ticket summary and adds a new label'
steps:
  - name: set_summary
    type: action
    action: jira.issue.update
    version: 1
    inputs:
      authToken: ${{ :secrets:jiraAuthToken }}
      domain: mycompany
      issueKey: "PROJ-123"
      fields:
        summary: "Updated: Critical production error resolved"
        description:
          type: "doc"
          version: 1
          content:
            - type: "paragraph"
              content:
                - type: "text"
                  text: "Root cause identified and fix deployed to production"
      update:
        labels:
          - add: "resolved"
          - add: "production"
      parameters:
        returnIssue: "true"
    next: end

この機械翻訳は、参考として提供されています。

パラメーターリファレンス