backlog api データ構造

1

backlogのデータの構造

backlogの構造を知ることで、APIが使いやすくなります。
全てのデータがつながっていることがわかり、感動すら覚えます。
センスがいいの一言なんですが、無駄も、無理もなく、シンプルに構成がすばらしいです。

プロジェクト project（業務ドメインごとに管理）


                    [id] => 12345（プロジェクトID）APIで使う
                    [projectKey] => XXXXXX（プロジェクトキー）APIで使う
                    [name] => XXXXX (プロジェクト名)
                    [chartEnabled] => 1
                    [subtaskingEnabled] =>
                    [projectLeaderCanEditProjectLeader] =>
                    [useWikiTreeView] =>
                    [textFormattingRule] => backlog
                    [archived] =>
                    [displayOrder] => 11
                    [useDevAttributes] => 1

課題 issue（タスクデータ、仕事の単位）


                    [id] => 12345（課題のID）APIで使う
                    [projectId] => 12345 (プロジェクトID) APIで使う
                    [issueKey] => XXXXX (プロジェクトkey) APIで使う
                    [key_id] => 123 (プロジェクトの後ろに[-ハイフン]IDで付与される、プロジェクト内のIDに近い、URLで表示される)
                    [summary] => 【課題タイトル】
                    [description] => 【課題概要コンテンツ】

課題コメント　comment（タスクの協働作業）


                    [id] => 123456(コメントID)APIで使う
                    [content] => 【コメント内容】

変更内容　changeLog　（何が変わったか、動いたのか）


                    [field] => assigner（変更された属性）
                    [field_text] => lbl.changelog.assigner（変更された属性）
                    [new_value] => XXX（変更前の値）
                    [old_value] => YYY　（変更後の値）
                    [type] => standard　（属性のタイプ、デフォルト属性）

ユーザ assignee createdUser　updatedUser（誰が、誰にデータ）


                    [id] => 12345（ユーザID）APIで使う
                    [userId] => XXXXX（ログイン名、お知らせにも使う）
                    [name] => XXXXX（ハンドルネーム、お知らせにも使う）
                    [roleType] => 1　（役割、数値固定定義）
                    [lang] => (言語設定、指定がない場合はnull)
                    [mailAddress] => xxx@xxxx.xx.xx
                    [nulabAccount] => (ヌーラボのアカウント/追加されている)
                    [keyword] => XXXXX　（検索キーワード）

お知らせ notifications（コミュニケーションデータ）


                    [id] => 12345678（お知らせ通知のID）APIで使う
                    [alreadyRead] => 1（既読未読）
                    [reason] => 4 (お知らせ通知種別)

添付ファイル attachments（資料のデジタル化、保存、共有）


                    [id] => 2222222（ファイルID）APIで使う
                    [name] => XXXX.xlsx（ファイル名）
                    [size] => 71791 (ファイルサイズ)

共有ファイル sharedFiles（デジタル化のひな形管理にも）


                    [id] => 333333 (共通ファイルID)　APIで使う
                    [type] => directory　（タイプ file or directory）
                    [dir] => / (ディレクトリ、/はルート)
                    [name] => XXXX (ディレクトリ名)
                    [size] => (ファイルサイズ、ディレクトリの場合はnull)
2

backlogの課題属性の種類

課題に属性がつけて管理することができます。
属性を利用することで、課題のカテゴライズ化、セグメント化が可能になります。

種別 issueType　(タスクの分類)


                    [id] => 12345　（種別ID）
                    [projectId] => 12345 (プロジェクトID) APIで使う
                    [name] => XXXX(種別名)
                    [color] => #7ea800
                    [displayOrder] => 0

カテゴリ　category (業務分類)


                    [id] => 12345　（カテゴリID）
                    [name] => XXXX　（カテゴリ名称）