backlogの課題データを取得するAPI
課題を指定して、課題に関連する情報を取得する
backlogの情報管理単位は、課題(タスク)になります。
そして、課題(タスク)に対して、時系列でコメントを付ける仕組みになっているのが特徴です。
ただし、コメントのコメントという概念はないです。
コメントという表現よりは、課題の進捗やプロセスを可視化するためすべての情報が管理することができます。
具体的には、Aさんが作業が終わったら、Bさんに作業を渡し、最後に課題(タスク)が完了するという一連の流れを記録しながら、進めていくことができます。
課題をAPIで使う場合は、idとkeyの2通りで使用することができます。
backlogの画面だと、urlに書いてある文字列が、key(issueIdKey)あり、
課題一覧APIで取得できるのがid(issueId)になります。
issueIdOrKeyは、idでも、keyでもどちらでもいいという仕組みです。
課題コメント一覧の取得
課題に登録されているコメントの一覧を取得します。
コメントが時系列に管理されているので、コメントを使って、課題の動きや進捗、協働者間のコミュニケーションを見ることができます。
backlog API
GET:/api/v2/issues/:issueIdOrKey/comments
URL パラメーター
| issueIdOrKey | 文字列 | 課題のID または 課題キー |
リクエストパラメーター
| minId | 数値 | 最小課題ID |
| maxId | 数値 | 最大課題ID |
| count | 数値 | 取得上限(1-100) デフォルトは20 |
| order | 文字列 | ascまたはdesc デフォルトはdesc |
レスポンスボディ php配列形式
[0] => Array
(
[id] => 123456 (コメントID) APIキーで使う
[content] =>【コメント文コンテンツ】
[changeLog] => Array
(
)
[createdUser] => Array (コメント作成者)
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
[stars] => Array
(
)
[notifications] => Array （お知らせ通知）
(
[0] => Array
(
[id] => 12345678（お知らせ通知のID）APIで使う
[alreadyRead] => 1（既読未読）
[reason] => 2 (お知らせ通知種別)
[user] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[resourceAlreadyRead] =>
)
[1] => Array
(
[id] => 12345678（お知らせ通知のID）APIで使う
[alreadyRead] => 1（既読未読）
[reason] => 2 (お知らせ通知種別)
[user] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[resourceAlreadyRead] =>
)
)
)
[1] => Array
(
[id] => 123456 (コメントID) APIキーで使う
[content] => 【コメント文コンテンツ】
[changeLog] => Array
(
[0] => Array
(
[field] => assigner （変更された属性）
[newValue] => XXXX (変更後の値)
[originalValue] => XXXX (変更前の値)
[attachmentInfo] =>
[attributeInfo] =>
[notificationInfo] =>
)
)
[createdUser] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
[stars] => Array
(
)
[notifications] => Array
(
[0] => Array
(
[id] => 12345678（お知らせ通知のID）APIで使う
[alreadyRead] => 1（既読未読）
[reason] => 4 (お知らせ通知種別)
[user] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[resourceAlreadyRead] => 1
)
)
)
課題の参加者一覧の取得
課題の参加者一覧を取得します。
登録者、担当者、お知らせユーザなど、課題に参加した人が出来ます。
backlog API
GET:/api/v2/issues/:issueIdOrKey/participants
URL パラメーター
| issueIdOrKey | 文字列 | 課題のID または 課題キー |
レスポンスボディ php配列形式
[0] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[1] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
課題添付ファイル一覧の取得
課題に添付されたファイルの一覧を取得します。
添付ファイルには、それぞれIDが振られています。（attachmentId）
ファイルの中身まで含めて、テキスト全文検索ができるといいけど、たぶん出来ないので、ファイルを外に出して別途全文検索機能と連動するのもありだと思います。
backlog API
GET:/api/v2/issues/:issueIdOrKey/attachments
URL パラメーター
| issueIdOrKey | 文字列 | 課題のID または 課題キー |
レスポンスボディ php配列形式
(
[id] => 12345 （添付ファイルID）
[name] => xxxx.png (ファイル名)
[size] => 42301 （ファイルサイズ）
[createdUser] => Array （作成者）
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
)
課題共有ファイル一覧の取得
プロジェクトのファイル共有機能にあるファイルの一覧を取得します。
共有ファイル機能は、課題画面から、「共通ファイルをリンク」という機能で使われ、共有ファイルがリンクされるとタブとして表示されます
APIは、ディレクトリとファイル名で管理されています。
ファイルを取得する場合は、直接pathを指定して、ダウンロードします。
backlog API
GET:/api/v2/issues/:issueIdOrKey/sharedFiles
URL パラメーター
| issueIdOrKey | 文字列 | 課題のID または 課題キー |
レスポンスボディ php配列形式
[0] => Array
(
[id] => 12345 （共通ファイルリンクID)
[type] => file
[dir] => /
[name] => XXX.xlsx (ファイル名)
[size] => 9411 （ファイルサイズ）
[createdUser] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
[updatedUser] =>
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
)