Read Issue（課題の読み出し）
GitHubの課題の内容を読み出します。
GitHub REST APIは、すべてのプルリストを課題として分類します。ただし、課題はプルリクエスト以外の別のGitHubオブジェクトで構成される場合もあります。つまり、/issuesエンドポイントは課題とプルリクエストの両方をレスポンスで返します。プルリクエストは、pull_requestキーで識別できます。/issuesエンドポイントから返されるプルリクエストのidが課題IDです。プルリクエストIDを特定するには、List pull requestsエンドポイントを使用します。
オプション
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
|
Organization（組織） |
課題が含まれるリポジトリを所有する組織を選択します。 ドロップダウンリストには、認証されたユーザーの組織が表示されます。リストは100組織に制限されます。 リポジトリが個人アカウントに属するときは、［-- orgになし --］オプションを選択します。 |
ドロップダウン | TRUE |
|
Repository（リポジトリ） |
課題が含まれるリポジトリを選択します。 ドロップダウンリストには、選択した［Organization（組織）］のリポジトリが表示されます。 ［-- 入力リポジトリフルネーム --］オプションを選択した場合、カードは［Organization（組織）］の選択を無視するため、［Repository（リポジトリ）］入力フィールドにリポジトリのフルネームを入力する必要があります。 |
ドロップダウン | TRUE |
入力
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
|
Repository（リポジトリ） |
|||
|
Full Name（フルネーム） |
リポジトリのフルネーム。 この入力フィールドは、［Repository（リポジトリ）］オプションで［-- 入力リポジトリフルネーム --］オプションを選択した場合に表示されます。 名前の形式は、リポジトリが組織内にある場合は<org_name>/<repo_name>、個人アカウントに属する場合は<owner_name>/<repo_name>にする必要があります。 リポジトリが存在しない、またはユーザーにリポジトリへのアクセス権がないときは、カードはエラーを返します。 |
テキスト | TRUE |
|
Pull Request（プルリクエスト） |
|||
|
Issue Number（課題番号） |
課題に割り当てられている番号。 |
数値 | TRUE |
出力
| フィールド | 定義 | タイプ |
|---|---|---|
|
Issue（課題） |
||
|
Issue ID（課題ID） |
課題の一意識別子。 |
数値 |
|
Issue Number（課題番号） |
課題の番号。 |
テキスト |
|
Issue Global Node ID（課題グローバルノードID） |
課題のnode_id値。 |
テキスト |
|
Active Lock Reason（アクティブロックの理由） |
課題またはプルリクエスト会話をロックする理由。次のいずれかの理由を使用しない場合、ロックは失敗します。
|
テキスト |
|
Author Association（作成者関連性） |
課題の作成者とリポジトリの関係。
|
テキスト |
|
HTML URL |
課題のURL。 |
テキスト |
|
State（状態） |
課題の状態。課題には、open、closed、またはallがあります。 |
テキスト |
|
Title（タイトル） |
課題のタイトル。 |
テキスト |
|
Description（説明） |
課題の説明。 |
テキスト |
|
User ID（ユーザーID） |
ユーザーの一意識別子。 | テキスト |
|
Username（ユーザー名） |
課題を挙げたユーザーのユーザー名。 |
テキスト |
|
Labels（ラベル） |
課題に関連付けられているラベルのリスト。 |
オブジェクトのリスト |
|
id |
ラベルの一意識別子。 |
数値 |
|
node_id |
ラベルのnode_id値。 |
テキスト |
|
Name（名前） |
ラベルの名前。ラベル名に絵文字を追加できます。通常の絵文字またはコロン形式のマークアップを使用します。 |
テキスト |
|
color（カラー） |
ラベルの16進カラーコード。先頭に#を付けません。 |
テキスト |
|
default（デフォルト） |
このラベルが課題のデフォルトラベルであるかどうかを示します。 |
True/False |
|
description（説明） |
ラベルの簡潔な説明。 |
テキスト |
|
Assignee ID（割り当て先ID） |
課題が割り当てられているユーザーの一意識別子。 |
テキスト |
|
Assignee Username（割り当て先ユーザー名） |
課題が割り当てられているユーザーのユーザー名。 |
テキスト |
|
Assignees（割り当て先） |
課題が割り当てられているユーザー。 |
オブジェクトのリスト |
|
login（ログイン） |
課題が割り当てられているユーザーのユーザー名。 |
テキスト |
|
id |
課題が割り当てられているユーザーの一意識別子。 |
数値 |
|
node_id |
割り当て先のnode_id値。 |
テキスト |
|
avatar_url |
ユーザーのアバターのURL。 |
テキスト |
|
html_url |
ユーザープロファイルのURL位置。 |
テキスト |
|
type（タイプ） |
課題が割り当てられているユーザーのタイプ。 |
テキスト |
|
site_admin |
割り当て先がサイト管理者であるかどうかを示します。 |
True/False |
|
Milestone ID（マイルストーンID） |
課題に関連付けられているマイルストーンの一意識別子。 |
テキスト |
|
Milestone Number（マイルストーン番号） |
課題に関連付けられているマイルストーン番号。 |
テキスト |
|
Milestone State（マイルストーン状態） |
課題に関連付けられているマイルストーンの状態。 |
テキスト |
|
Milestone Title（マイルストーンタイトル） |
課題に関連付けられているマイルストーンのタイトル。 |
テキスト |
|
Is Locked?（ロック？） |
課題がロックされているかどうかを示します。 |
True/False |
|
Comments Count（コメント数） |
課題に関するコメントの数。 |
数値 |
|
Pull Request URL（プルリクエストURL） |
課題のプルリクエストのURL位置。 |
テキスト |
|
Closed At（クローズ日時） |
課題がクローズされた日時。 |
日時 |
|
Created At（作成日時） |
オブジェクトが作成された日時。 | 日時 |
|
Updated At（更新日時） |
課題が最後に更新された日時。 |
日時 |
|
Closed By（クローズユーザー） |
更新された課題をクローズしたユーザーに関するメタデータ（クローズされた場合）。 |
テキスト |