2
backlogのプロジェクトデータを取得するAPI
プロジェクトを指定して情報を得る
api_keyとプロジェクトidを使って、プロジェクト内のデータを取得します。
プロジェクトidは、プロジェクト一覧APIから取得することができます
または、backlog画面のプロジェクト設定画面を開くと、urlに書いてあります
さらに、IDではなく、プロジェクトキー（プロジェクトごとにユーザが設定するユニークなキー）でも可能です。
2-1
プロジェクトの最近の更新内容の履歴を取得
プロジェクト上の最近の更新内容の活動状況を種類別に一覧を取得します。
これで、プロジェクト内の全部の動きがわかります。
プロジェクト内の更新内容は、typeとして26分類されています。
typeごとにidが管理されています。
backlog API
GET:/api/v2/projects/:projectIdOrKey/activities
URL パラメーター
| projectIdOrKey | 文字列 | プロジェクトのID または プロジェクトキー |
リクエストパラメーター
| activityTypeId[] | 数値 | 最近の更新の種別 |
| minId | 数値 | 最小プロジェクトID |
| maxId | 数値 | 最大プロジェクトID |
| count | 数値 | 取得上限(1-100) デフォルトは20件 |
| order | 文字列 | ascまたはdesc デフォルトはdesc |
レスポンスボディ php配列形式 type = 2
[0] => Array
(
[id] => 184905574
[project] => Array
(
[id] => 12345（プロジェクトID）APIで使う
[projectKey] => XXXXXX（プロジェクトキー）APIで使う
[name] => XXXXX (プロジェクト名)
[chartEnabled] => 1
[subtaskingEnabled] =>
[projectLeaderCanEditProjectLeader] =>
[useWikiTreeView] =>
[textFormattingRule] => backlog
[archived] =>
[displayOrder] => 11
[useDevAttributes] => 1
)
[type] => 2（最近の更新の種別 1-26の数字で管理されている）
[content] => Array
(
[id] => 12345（課題のID）APIで使う
[key_id] => 123 (プロジェクトの後ろに[-ハイフン]IDで付与される、プロジェクト内のIDに近い、URLで表示される)
[summary] => 【課題タイトル】
[description] => 【課題概要コンテンツ】
[comment] => Array
(
[id] => 123456(コメントID)APIで使う
[content] => 【コメント内容】
)
[changes] => Array（変更内容は、複数のなる場合もある）
(
[0] => Array
(
[field] => assigner
[field_text] => lbl.changelog.assigner
[new_value] => XXX（変更後の値）
[old_value] => XXX（変更前の値）
[type] => standard
)
[1] => Array
(
[field] => attachment（変更された属性）
[field_text] => lbl.changelog.attachment（変更された属性）
[new_value] => XXX（変更後の値）
[old_value] => XXX（変更前の値）
[type] => standard
)
)
[attachments] => Array
(
[0] => Array
(
[id] => 2222222（ファイルID）APIで使う
[name] => XXXX.xlsx（ファイル名）
[size] => 71791 (ファイルサイズ)
)
)
[shared_files] => 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
)
[1] => 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] =>
)
)
[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 形式)
)
レスポンスボディ php配列形式 type = 1
[7] => Array
(
[id] => 184890819
[project] => Array
(
[id] => 12345（プロジェクトID）APIで使う
[projectKey] => XXXXXX（プロジェクトキー）APIで使う
[name] => XXXXX (プロジェクト名)
[chartEnabled] => 1
[subtaskingEnabled] =>
[projectLeaderCanEditProjectLeader] =>
[useWikiTreeView] =>
[textFormattingRule] => backlog
[archived] =>
[displayOrder] => 11
[useDevAttributes] => 1
)
[type] => 1（最近の更新の種別 1-26の数字で管理されている）
[content] => Array
(
[id] => 12345（課題のID）APIで使う
[key_id] => 123 (プロジェクトの後ろに[-ハイフン]IDで付与される、プロジェクト内のIDに近い、URLで表示される)
[summary] => 【課題タイトル】
[description] => 【課題概要コンテンツ】
)
[notifications] => Array
(
[0] => Array
(
[id] => 12345678（お知らせ通知のID）APIで使う
[alreadyRead] => 1（既読未読）
[reason] => 1 (お知らせ通知種別)
[user] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[resourceAlreadyRead] => 1
)
)
[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 形式)
)
レスポンスボディ php配列形式 type = 3
[16] => Array
(
[id] => 184865291
[project] => Array
(
[id] => 12345（プロジェクトID）APIで使う
[projectKey] => XXXXXX（プロジェクトキー）APIで使う
[name] => XXXXX (プロジェクト名)
[chartEnabled] => 1
[subtaskingEnabled] =>
[projectLeaderCanEditProjectLeader] =>
[useWikiTreeView] =>
[textFormattingRule] => backlog
[archived] =>
[displayOrder] => 11
[useDevAttributes] => 1
)
[type] => 3（最近の更新の種別 1-26の数字で管理されている）
[content] => Array
(
[id] => 12345（課題のID）APIで使う
[key_id] => 123 (プロジェクトの後ろに[-ハイフン]IDで付与される、プロジェクト内のIDに近い、URLで表示される)
[summary] => 【課題タイトル】
[description] => 【課題概要コンテンツ】
[comment] => Array
(
[id] => 123456(コメントID)APIで使う
[content] => 【コメント内容】
)
[changes] => Array
(
)
[attachments] => Array
(
)
[shared_files] => 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] =>
)
)
[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 形式)
)
レスポンス説明
| type | 数値(1-26) | 最近の更新の種別 |
| reason | 数値 | お知らせ通知の種別 |
2-2
プロジェクトユーザー一覧の取得
プロジェクトに登録されているユーザーの一覧を取得します。
プロジェクト数が多くなり、ユーザ数も多くなると、ユーザを整理するのに便利です。
backlog API
GET:/api/v2/projects/:projectIdOrKey/users
URL パラメーター
| projectIdOrKey | 文字列 | プロジェクトのID または プロジェクトキー |
リクエストパラメーター
| excludeGroupMembers | 真偽値 | グループを介してプロジェクトに参加しているメンバーを除く |
レスポンスボディ 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 （検索キーワード）
)
2-3
プロジェクトの共有ファイル一覧の取得
プロジェクト内の共有ファイルの一覧を取得します。
ディレクトリの場合は、/にルートになります。
backlog API
GET:/api/v2/projects/:projectIdOrKey/files/metadata/:path
URL パラメーター
| projectIdOrKey | 文字列 | プロジェクトのID または プロジェクトキー |
| path | 文字列 | ディレクトリのパス |
リクエストパラメーター
| order | 文字列 | ascまたはdesc デフォルトはdesc |
| offset | 数値 | |
| count | 数値 | 取得上限(1-1000) デフォルトは1000 |
レスポンスボディ php配列形式
[0] => Array
(
[id] => 333333 (共通ファイルID) APIで使う
[type] => directory （タイプ file or directory）
[dir] => / (ディレクトリ、/はルート)
[name] => XXXX (ディレクトリ名)
[size] => (ファイルサイズ、ディレクトリの場合はnull)
[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 形式)
)
2-4
Wikiページ一覧の取得
プロジェクト内のWikiページの一覧を取得します。
課題とwikiをうまく使い分けて情報を管理できれば運用としてはベストです。
backlog API
GET:/api/v2/wikis
リクエストパラメーター
| projectIdOrKey | 数値 | プロジェクトのID または プロジェクトキー（必須） |
| keyword | 文字列 | 検索キーワード |
レスポンスボディ php配列形式
[4] => Array
(
[id] => 12345 (wikiのIUD)
[projectId] => 12345 (プロジェクトID) APIで使う
[name] => サイネージ仕様
[content] =>
[tags] => Array
(
)
[attachments] => Array
(
[0] => Array
(
[id] => 2222222（ファイルID）APIで使う
[name] => XXXX.xlsx（ファイル名）
[size] => 71791 (ファイルサイズ)
[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 形式)
)
[1] => Array
(
[id] => 2222222（ファイルID）APIで使う
[name] => XXXX.xlsx（ファイル名）
[size] => 71791 (ファイルサイズ)
[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 形式)
)
)
[sharedFiles] => Array
(
)
[stars] => 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 形式)
[updatedUser] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
)