要約

この記事では、Jira や Jira Service Management の製品でカスタム フィールドの ID を取得するための複数の方法を説明しています。
カスタム フィールドの ID は、フィールド名ではなく ID が返される、API ペイロードの処理や SQL クエリの実行 (サーバーまたは Data Center) 時に便利です。

課題の表示ページでカスタム フィールドを確認する

Chrome または Firefox では開発者パネルを利用し、課題ページに存在するカスタム フィールドの ID を素早く特定できます。
このオプションでは Jira の管理権限は不要です。

1. ID を確認したいカスタム フィールドが含まれている課題にアクセスします。
2. フィールドを UI に表示するため、フィールドに値が入力されていることを確認します。
3. 画面を右クリックして [Inspect] を選択します。
4. カスタム フィールドの名前をクリックします。

5. 開発者ツールのパネルのスレッド末尾でカスタム フィールドの名前と ID を確認できます。例:
   

   issue-field-heading-styled-field-heading.customfield_XXXXXX

   

高度な JQL ビューを利用する

リスト ビューと高度な JQL の組み合わせを使うと、結果に表示されているカスタム フィールドの ID を特定できます。
このオプションでは Jira の管理権限は不要です。

1. 対象のフィールドを含む課題を返すシンプルな JQL を作成します。
2. このクエリの実行後、リスト ビューを表示していない場合はリスト ビューに切り替えます。
3. 対象のフィールドを結果の列として追加します。
4. 列でフィールド名をクリックし、対象のカスタム フィールドで結果を並べ替えます。
5. JQL タイプが高度な検索ではない場合はそれに切り替えます。
6. フィールドの ID がORDER BY 句に記載されます。
   
   

Jira Home Directory and DB Browser プラグインを利用する

この手順はサーバーまたは Data Center 製品でのみ利用できます。

1. 以降の手順を実行するには Jira 管理者の権限が必要です。
2. Jira Home Directory And DB Browser をインストールします。  

3. Db Console にナビゲートします。
   

4. customfield テーブルを選択して実行します。

URL を利用する

以降の手順を完了するには Jira 管理グローバル権限が必要です。

1. 設定 () > [課題] > [カスタム フィールド] ([フィールド] セクション) に移動します。
2. ID を取得したいカスタム フィールドの右側で [その他] (⋯) アイコンをクリックします。
3. [フィールド情報を表示] オプションを選択します。
4. ブラウザで URL を確認します。フィールドの ID が含まれています。

上記の例のカスタム フィールドの ID は 10026 です。

API を利用する

オプション 1:

Get Fields Jira Cloud API エンドポイントを使うと、カスタム フィールドを一覧で返せます。追加の例や、このエンドポイントの利用に関連するルーツについては、Cloud REST API ドキュメントまたは JIRA Server REST API (8.13.9/8.18.1 以前 または 8.13.10/8.18.2 以降) をご確認ください。対象のフィールドやその ID を特定するには、返される JSON  データを絞り込む必要があります。

ブラウザにペーストする、<JIRA_BASE_URL> を置き換える URL は次のとおりです。

• <JIRA_BASE_URL>/rest/api/latest/field 

API からのレスポンスの例

{  
    "id": "customfield_10026",
    "key": "customfield_10026",
    "name": "Approvals",
    "untranslatedName": "Approvals",
    "custom": true,
    "orderable": true,
    "navigable": true,
    "searchable": true,
    "clauseNames": [
        "Approvals",
        "Approvals[Approvals]",
        "cf[10026]"
    ],
    "schema": {
        "type": "sd-approvals",
        "custom": "com.atlassian.servicedesk.approvals-plugin:sd-approvals",
        "customId": 10026
    }
}

オプション 2:

Get Issue REST API エンドポイントを利用して特定の課題の詳細情報を取得し、?expand=names パラメーターを追加して、スコープ内のすべてのカスタム フィールド名の一覧を取得できます。BS-1 の場合の例です。

• <JIRA_BASE_URL>/rest/api/latest/issue/BS-1?expand=names 

出力の最後のセクションでフィールドを見つけ、"customfield_XXXXX" で ID を記録します (ここでは Sprint カスタム フィールドの ID が 10105、Story Points の ID が 10106 であることがわかります)。

names: {
...
customfield_10105: "Sprint",
customfield_10106: "Story Points",
...
}

XML へのエクスポート

課題で利用されているカスタム フィールドの ID は、Jira や Jira Service Management のユーザー インターフェイス内で課題を XML にエクスポートすることで取得できます。この方法では、課題に存在するフィールドについてのみフィールド ID が表示されます。

1. カスタム フィールドの ID を取得したい課題を開きます。
2. 右上の [アクション] (⋯) アイコンをクリックします。
3. [XML にエクスポート] オプションを選択します。新しいタブが開き、課題の詳細が XML 形式で表示されます。
4. フィールド名を検索してカスタム フィールド ID を取得します。

<customfield id="customfield_10026" key="com.atlassian.servicedesk.approvals-plugin:sd-approvals">
    <customfieldname>Approvals</customfieldname>
    <customfieldvalues> </customfieldvalues>
</customfield>

上記の例では、Approvals フィールドのカスタム フィールド ID が 10026 です。

データベースから

次の DB クエリを使います。

jiradb=# select id from customfield where cfname='Approvals' ;
  id   
-------
 10026
(1 row)

jiradb=#