backlog.getProjectSummary
プロジェクト状況を取得します。
プロジェクト状況には以下が含まれます。
- 状態毎の課題件数
- マイルストーン一覧(プロジェクトホームに表示しているもの)
- 現在のマイルストーン(あれば)
現在のマイルストーンにはバーンダウンチャート画像データが含まれます。
(プレミアムプラン以上をご利用で、プロジェクトが「チャートを利用する」場合にのみバーンダウンチャートを取得できます)
メソッド名
backlog.getProjectSummary
パラメータ
| パラメータ名 | 内容 |
|---|---|
| projectId(必須) | プロジェクトID (例：123) |
レスポンス
プロジェクト状況structを返します。
プロジェクト状況structの各フィールドの意味は下記の通りです。
| フィールド | 説明 | 例 |
|---|---|---|
| id | プロジェクトID | 2 |
| name | プロジェクト名 | Webサイト構築 |
| key | プロジェクトキー | BLGWEBSITE |
| url | プロジェクトホームURL | https://demo.backlog.jp/BLGWEBSITE |
| statuses | 状態毎の課題件数の配列 | |
| └ status | 状態毎の課題件数 | |
| ├ id | 状態ID | 1 |
| ├ name | 状態名 | 処理中 |
| └ count | 課題件数 | 10 |
| milestones | マイルストーンの配列 | |
| └ milestone | マイルストーン | |
| ├ id | マイルストーンID | 301 |
| ├ name | マイルストーン名 | 正式版1.0 |
| ├ due_date | リリース予定日(YYYYMMDD) | 20101028 |
| └ statuses | このマイルストーンの状態毎の課題件数 | |
| └ status | 状態毎の課題件数 | |
| ├ id | 状態ID | 3 |
| ├ name | 状態名 | 処理済み |
| └ count | 課題件数 | 5 |
| current_milestone | 現在のマイルストーン(該当が無い場合は属性も無し) | |
| ├ id | マイルストーンID | 301 |
| ├ name | マイルストーン名 | 正式版1.0 |
| ├ due_date | リリース予定日(YYYYMMDD) | 20101028 |
| └ burndown_chart | バーンダウンチャート画像 (base64) |
リクエストXMLの例
<?xml version="1.0" encoding="utf-8"?>
<methodCall>
<methodName>backlog.getProjectSummary</methodName>
<params>
<param>
<value>
<int>123</int>
</value>
</param>
</params>
</methodCall>レスポンスXMLの例
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>id</name>
<value>
<i4>123</i4>
</value>
</member>
<member>
<name>key</name>
<value>
<string>BLG</string>
</value>
</member>
<member>
<name>name</name>
<value>
<string>バックログ</string>
</value>
</member>
<member>
<name>url</name>
<value>
<string>https://demo.backlog.jp/projects/BLG</string>
</value>
</member>
<member>
<name>statuses</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>267</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>未対応</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>1</i4>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>28</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>処理中</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>2</i4>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>16</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>処理済み</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>3</i4>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>1861</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>完了</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>4</i4>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>milestones</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>due_date</name>
<value>
<string>20101028</string>
</value>
</member>
<member>
<name>name</name>
<value>
<string>R2010-10-28 改善リリース</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>1074</i4>
</value>
</member>
<member>
<name>statuses</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>3</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>未対応</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>1</i4>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>3</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>処理中</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>2</i4>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>4</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>処理済み</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>3</i4>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>完了</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>4</i4>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>due_date</name>
<value>
<string>20101006</string>
</value>
</member>
<member>
<name>name</name>
<value>
<string>R2010-10-06 改善リリース</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>1074</i4>
</value>
</member>
<member>
<name>statuses</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>未対応</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>1</i4>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>処理中</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>2</i4>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>処理済み</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>3</i4>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>count</name>
<value>
<i4>9</i4>
</value>
</member>
<member>
<name>name</name>
<value>
<string>完了</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>4</i4>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>current_milestone</name>
<value>
<struct>
<member>
<name>burndown_chart</name>
<value>
<base64>iVBORw0KGgoAAAANSUhEUgAAAcIAAAD...[省略]...QREgRBImQhEfJBJgiCICIZ/w/glHXiMOgrogAAAABJRU5ErkJggg==</base64>
</value>
</member>
<member>
<name>due_date</name>
<value>
<string>20101022</string>
</value>
</member>
<member>
<name>name</name>
<value>
<string>R2010-10-28</string>
</value>
</member>
<member>
<name>id</name>
<value>
<i4>49</i4>
</value>
</member>
</struct>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>
