JIRAでプロジェクトID(pid), コンポーネントID、チケットタイプ等を確認する方法

4794 ワード
jira Atlassian jira テキストリンク

JIRAで各種IDを簡単に取得する方法をまとめます

対象
- プロジェクトID(projectid, pid)
- コンポーネントID
- チケットタイプ
- フィールドID(エピックリンクなどのカスタムフィールド含む)
- リリースバージョン
- 優先度

プロジェクトID

下記リンクにブラウザからアクセス
https://{your.jira.hostname}/rest/api/2/project/{projectname}

下記のようなJSONが返ってきます。
このidがプロジェクトIDです。

{
    "expand": "description,lead,issueTypes,url,projectKeys,permissions",
    "self": "https://{jira.hostname}/rest/api/2/project/10000",
    "id": "10000",
    "key": "TEST",
    "description": "",
    "lead": {
・・・

お察しの通りプロジェクトIDからプロジェクト名を確認することもできます。
https://{your.jira.hostname}/rest/api/2/project/{projectid}

コンポーネントID

下記リンクにブラウザからアクセス
https://{your.jira.hostname}/rest/api/2/project/{projectname}/components

下記のようなJSONが返ってきます
このidがコンポーネントIDです。

[
    {
        "self": "https://{jira.hostname}/rest/api/2/component/10002",
        "id": "10002",
        "name": "お問い合わせ",
        "assigneeType": "PROJECT_DEFAULT",
        "realAssigneeType": "PROJECT_DEFAULT",
        "isAssigneeTypeValid": false,
        "project": "TEST",
        "projectId": 10000
    },
    {
        "self": "https://{jira.hostname}/rest/api/2/component/10001",

実は先程のプロジェクト情報取得APIの中に含まれていたりします。
https://{your.jira.hostname}/rest/api/2/project/{projectname}

チケットタイプ(issuetype)

下記リンクにブラウザからアクセス
https://{your.jira.hostname}/rest/api/2/issuetype

こちらにはURLからプロジェクトIDがありません。
現在のユーザで参照できるチケットタイプのみが表示されるようです。

下記のようなJSONが返ってきます
このidがチケットタイプです。

[
    {
        "self": "https://{jira.hostname}/rest/api/2/issuetype/10001",
        "id": "10001",
        "description": "",
        "iconUrl": "https://{jira.hostname}/secure/viewavatar?size=medium&avatarId=10315&avatarType=issuetype",
        "name": "ストーリー",
        "subtask": false,
        "avatarId": 10315
    },
    {
        "self": "https://{jira.hostname}/rest/api/2/issuetype/10002",

こちらも実はプロジェクト取得APIでも取得できています。

もしお探しのチケットタイプが見つからない場合は下記のURLにアクセスし、
返ってきたJSONからissuetypeを探してもよいかもしれません。
https://{your.jira.hostname}/rest/api/3/issue/{ticketid}

返ってきたJSONの例

{
    "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
    "id": "10002",
    "self": "https://{jira.hostname}/rest/api/3/issue/10002",
    "key": "TEST-3",
    "fields": {
        "statuscategorychangedate": "2019-10-29T00:49:20.233+0900",
        "issuetype": {
            "self": "https://{jira.hostname}/rest/api/3/issuetype/10000",
            "id": "10000",

特殊フィールド名

JIRA APIを使って入力値を操作したい場合や、JIRAのチケット作成URLを作成したい場合、
各種フィールド名が必要になってきます。

要約(= summary)やラベル(= labels)はすぐにわかりますが、
エピックリンクやJIRA WBSガントチャートの進捗率などは簡単にはわかりません。

簡単に調べる方法

chromeでチケット作成フォーム開き、対象のフィールド(今回はエピックリンク)にフォーカスを当てた状態で
右クリック→検証 で対象のフィールド名がわかります。
今回の場合はcutomfield_10014がエピックリンクのフィールド名です。

参考

【JIRA】課題(issue)チケットをurlやリンクで作成するメモ - urlパラメータでデフォルト値を設定したり
Confluence で JIRA の Issue テンプレートを作成する
JIRA APIを使用してチケットを作成する

その他ID

その他の情報も同様に取得できます。

リリースバージョン
https://{your.jira.hostname}/rest/api/2/project/{projectname}/version

優先度
https://{your.jira.hostname}/rest/api/2/priority

もっと知りたい方はJIRA APIのドキュメントに色々載っています。
https://developer.atlassian.com/cloud/jira/platform/rest/v2/

それではよいJIRAライフを！