4
backlogのユーザ稼働データを取得するAPI
ユーザを指定してユーザに関連する情報を取得する
ユーザがbacklog上でどのような課題（タスク）をやっているのか情報を取得することができます。
ユーザ別の動きをマネジメントするときに役立てることができます。
APIを使ってbacklogのデータをDB等に保存している場合は、ユーザのAPIを使って、データに漏れがないか等チェックすることにも使用できます。
4-1
ウォッチ一覧の取得
ウォッチの一覧を取得します。
ウオッチはユーザ別に管理されていますので、ユーザの指定が必要になります。
課題が多く、課題やコメントが更新される頻度が高い場合は、自分が欲しい課題が埋もれないようにするのにウオッチ機能が便利です。 backlogの画面から、ウオッチボタンを押すだけで課題をウオッチ管理することができます。
backlog API
GET:/api/v2/users/:userId/watchings
URL パラメーター
| userId | 数値 | ユーザーのID |
リクエストパラメーター
| order | 文字列 | ascまたはdesc デフォルトはdesc |
| sort | 文字列 | ソートに使用する属性名,created,updated,issueUpdated,デフォルトはissueUpdated |
| count | 数値 | 取得上限(1-100) デフォルトは20 |
| offset | 数値 | |
| resourceAlreadyRead | 真偽値 | trueの場合は既読のウォッチ、falseの場合は未読のウォッチ、指定しない場合は両方 |
| issueId[] | 数値 | 課題のID |
レスポンスボディ php配列形式
[0] => Array
(
[id] => 12345 (ウオッチID) APIで使う
[resourceAlreadyRead] =>
[note] => （ウオッチメモ）
[type] => issue
[issue] => Array
(
[id] => 12345（課題のID）APIで使う
[projectId] => 12345 (プロジェクトID) APIで使う
[issueKey] => XXXXX (プロジェクトkey) APIで使う
[key_id] => 123 (プロジェクトの後ろに[-ハイフン]IDで付与される、プロジェクト内のIDに近い、URLで表示される)
[issueType] => Array
(
[id] => 12345 種別ID）
[projectId] => 12345 (プロジェクトID) APIで使う
[name] => XXXX(種別名)
[color] => #7ea800
[displayOrder] => 0
)
[summary] => 【課題タイトル】
[description] => 【課題概要コンテンツ】
[resolution] =>
[priority] => Array
(
[id] => 3
[name] => 中
)
[status] => Array
(
[id] => 123 (ステータスid)
[projectId] => 12345 (プロジェクトID) APIで使う
[name] => 未対応 (スタータス名）
[color] => #ed8077
[displayOrder] => 1000
)
[assignee] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[category] => Array
(
[0] => Array
(
[id] => 382085
[name] => グーグル予約
[displayOrder] => 2147483646
)
)
[versions] => Array
(
)
[milestone] => Array
(
)
[startDate] => 2021-05-19T00:00:00Z
[dueDate] =>
[estimatedHours] =>
[actualHours] =>
[parentIssueId] =>
[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 形式)
[customFields] => 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 形式)
)
)
[sharedFiles] => Array
(
)
[stars] => Array
(
)
)
[lastContentUpdated] => 2021-05-14T10:55:51Z
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
)
[1] => Array
(
[id] => 12345 (ウオッチID) APIで使う
[resourceAlreadyRead] =>
[note] => （ウオッチメモ）
[type] => issue
[issue] => Array
(
[id] => 12345（課題のID）APIで使う
[projectId] => 12345 (プロジェクトID) APIで使う
[issueKey] => XXXXX (プロジェクトkey) APIで使う
[key_id] => 123 (プロジェクトの後ろに[-ハイフン]IDで付与される、プロジェクト内のIDに近い、URLで表示される)
[issueType] => Array
(
[id] => 12345 種別ID）
[projectId] => 12345 (プロジェクトID) APIで使う
[name] => XXXX(種別名)
[color] => #7ea800
[displayOrder] => 0
)
[summary] => 【タイトル】
[description] => 【課題概要コンテンツ】
[resolution] =>
[priority] => Array
(
[id] => 3
[name] => 中
)
[status] => Array
(
[id] => 123 (ステータスID)
[projectId] => 12345 (プロジェクトID) APIで使う
[name] => 処理中 (スタータス名）
[color] => #4488c5
[displayOrder] => 2000
)
[assignee] => Array
(
[id] => 12345（ユーザID）APIで使う
[userId] => XXXXX（ログイン名、お知らせにも使う）
[name] => XXXXX（ハンドルネーム、お知らせにも使う）
[roleType] => 1 （役割、数値固定定義）
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX （検索キーワード）
)
[category] => Array
(
)
[versions] => Array
(
)
[milestone] => Array
(
)
[startDate] =>
[dueDate] =>
[estimatedHours] =>
[actualHours] =>
[parentIssueId] =>
[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 形式)
[customFields] => 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
(
)
)
[lastContentUpdated] => 2021-05-14T06:44:28Z
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
)
4-2
ユーザーの最近の活動の取得
ユーザーの最近の活動の一覧を取得し、ユーザ別の稼働状況を見ることができます。
updatedはなく、createdのみになります。
changesは特殊ですが、変わったことがわかるので便利です（コメントに付く）
backlog API
GET:/api/v2/users/:userId/activities
URL パラメーター
| userId | 数値 | ユーザーのID |
リクエストパラメーター
| activityTypeId[] | 数値 | 最近の更新の種別 |
| minId | 数値 | 最小ID |
| maxId | 数値 | 最大ID |
| count | 数値 | 取得上限(1-100) デフォルトは20 |
| order | 文字列 | ascまたはdesc デフォルトはdesc |
レスポンスボディ php配列形式
[0] => Array
(
[id] => 184861074
[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 （種別）
[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
)
)
[attachments] => Array
(
)
[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] =>
)
)
[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] => 184782918
[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
[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
)
)
[attachments] => Array
(
)
[shared_files] => Array
(
)
)
[notifications] => Array
(
[0] => Array
(
[id] => 12345678（お知らせ通知のID）APIで使う
[alreadyRead] => 1（既読未読）
[reason] => 4 (お知らせ通知種別)
[user] => Array
(
[id] => 43978
[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 形式)
)
レスポンス説明
| type | 数値 | 最近の更新の種別 |
| reason | 数値 | お知らせ通知の種別 |