backlog.updateIssue｜API｜開発者向け｜どこでもプロジェクト管理バックログ

メソッド名

backlog.updateIssue

権限

「一般ユーザ」以上の権限が必要です。

パラメータ

structの要素に下記パラメータが指定できます。
key (課題キー)は、課題を指定するために必須です。
変更したい項目だけ値を設定してください。
指定されていない項目は更新されません。

空の値を指定することで「未設定」にすることができる項目があります。(カテゴリなど)

backlog.updateIssueパラメータ
パラメータ名	型	内容
key (必須)	string	課題キー (例：BLG-10)
summary	string	課題の件名
description	string	課題の詳細
start_date	string	開始日(YYYYMMDD) 値を空で指定すると「未設定」にすることができます。 (プレミアムプラン以上で指定可)
due_date	string	期限日(YYYYMMDD) 値を空で指定すると「未設定」にすることができます。
estimated_hours	double	予定時間(hour) 0.00〜999.00で指定できます。値を空で指定すると「未設定」にすることができます。 (プレミアムプラン以上で指定可)
actual_hours	double	実績時間(hour) 0.00〜999.00で指定できます。値を空で指定すると「未設定」にすることができます。 (プレミアムプラン以上で指定可)
issueTypeId または issueType	issueTypeId は int、 issueType は string	種別ID または種別名 (種別はgetIssueTypesで取得できます)
componentId または component	componentId は int または intのarray、 component は string または stringのarray	カテゴリID またはカテゴリ名 (カテゴリはgetComponentsで取得できます) 値を空で指定すると「未設定」にすることができます。
versionId または version	versionId は int または intのarray、 version は string または stringのarray	発生バージョンID または発生バージョン名 (発生バージョンはgetVersionsで取得できます) 値を空で指定すると「未設定」にすることができます。
milestoneId または milestone	milestoneId は int または intのarray、 milestone は string または stringのarray	マイルストーンID またはマイルストーン名 (マイルストーンはgetVersionsで取得できます) 値を空で指定すると「未設定」にすることができます。
priorityId または priority	int または string	優先度ID または優先度名 2 : 高 3 : 中 4 : 低
assignerId	int	担当者ユーザID (プロジェクト参加ユーザはgetUsersで取得できます) 値を空で指定すると「未設定」にすることができます。
resolutionId	int	完了理由ID 0 : 対応済み 1 : 対応しない 2 : 無効 3 : 重複 4 : 再現しない値を空で指定すると「未設定」にすることができます。
comment	string	コメント
custom_fields	array(struct)	カスタム属性に登録するパラメータ一覧(マックスプランで指定可)

custom_fields の1項目に指定できるパラメータ情報です。

カスタム属性形式が文字列、数値、日付の場合 (typeId=1,2,3,4)

backlog.createIssue 共通レスポンスフィールド
パラメータ名	型	内容
├ id	int	カスタム属性ID
└ values	string	カスタム属性値

カスタム属性形式がリストの場合 (typeId=5,6,7,8)

backlog.createIssue 共通レスポンスフィールド
パラメータ名	型	内容
├ id	int	対象とするカスタム属性Id
├ other_text	string	選択肢以外の任意の文字列（その他が入力可能なリストのみ有効）
└ values	int または array(int)	リストの項目 ID

レスポンス

更新した課題structのarrayを返します。
課題structの各フィールドの意味は下記の通りです。

backlog.updateIssue レスポンスフィールド
フィールド	説明	例
id	課題ID	73
key	課題キー	BLGWEBSITE-213
summary	件名	トップページのデザイン決定
description	詳細	トップページのデザイン決定します
url	課題のURL	https://demo.backlog.jp/BLGWEBSITE-213
due_date	期限日	20090821
start_date	開始日	20090801
estimated_hours	予定時間	3.5
actual_hours	実績時間	5.5
issueType	種別	-
├ id	種別ID	5
├ name	種別名	タスク
└ color	種別色	#990000
priority	優先度	-
├ id	優先度ID	3
└ name	優先度	中
resolution	完了理由	-
├ id	完了理由ID	0
└ name	完了理由	対応済み
status	状態	-
├ id	状態ID	2
└ name	状態	処理中
components	カテゴリ	-
├ id	カテゴリID	1967
└ name	カテゴリ名	プロモーション
versions	発生バージョン	-
├ id	発生バージョンID	732
├ name	発生バージョン名	デザイン案作成
└ date	リリース予定日	20090910
milestones	マイルストーン	-
├ id	マイルストーンID	733
├ name	マイルストーン名	サイトオープン
└ date	リリース予定日	20091010
created_user	登録者	-
├ id	ユーザID	2
└ name	ハンドルネーム	やまもと
assigner	担当者	-
├ id	ユーザID	3
└ name	ハンドルネーム	山田
created_on	登録日時	20090731151859
updated_on	最終更新日時	20090812132418

マックスプランであればカスタム属性の値が登録結果に含まれます。
共通項目に含まれるカスタム属性形式によって、レスポンス形式が決まります。

共通

backlog.findIssue 共通レスポンスフィールド
フィールド	説明	例
custom_fields	カスタム属性	Array(struct)
├ id	カスタム属性ID	4
├ name	カスタム属性名	OS
├ type_id	カスタム属性形式 1 : 文字列 2 : 文章 3 : 数値 4 : 日付 5 : 単一リスト 6 : 複数リスト 7 : チェックボックス 8 : ラジオ	3
├ description	カスタム属性説明	障害が発生した OS
├ required	必須属性項目 1 : true 0 : false	0

カスタム属性形式が文字列、数値、日付の場合 (typeId=1,2,3,4)

backlog.findIssue 文字列、数値、日付パラメータ
フィールド	説明	例
└ value	カスタム属性値	20110302（日付の場合）

カスタム属性形式が単一リスト、複数リストの場合 (typeId=5,6)

backlog.findIssue リストパラメータ
フィールド	説明	例
└values	選択項目値	Array(1,3)

カスタム属性形式が上記以外の場合 (typeId=7,8)

backlog.findIssue リストパラメータ
フィールド	説明	例
├allow_input	その他入力可能状態（チェックボックス、ラジオ時のみ） 1 : true 0 : false	1
├other_text	その他項目で入力した値	Android
└values	選択項目値	Array(1,3)

リクエストXMLの例

<?xml version="1.0" encoding="utf-8"?>
<methodCall>
  <methodName>backlog.updateIssue</methodName>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>description</name>
            <value>
              <string>XML-RPCで課題を登録してみるテストです。
いわゆるBacklogAPIです。

詳細を追記します。</string>
            </value>
          </member>
          <member>
            <name>key</name>
            <value>
              <string>DORA-310</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodCall>

レスポンスXMLの例

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>priority</name>
            <value>
              <struct>
                <member>
                  <name>name</name>
                  <value>
                    <string>高</string>
                  </value>
                </member>
                <member>
                  <name>id</name>
                  <value>
                    <i4>2</i4>
                  </value>
                </member>
              </struct>
            </value>
          </member>
          <member>
            <name>created_user</name>
            <value>
              <struct>
                <member>
                  <name>name</name>
                  <value>
                    <string>demo</string>
                  </value>
                </member>
                <member>
                  <name>id</name>
                  <value>
                    <string>2</string>
                  </value>
                </member>
              </struct>
            </value>
          </member>
          <member>
            <name>status</name>
            <value>
              <struct>
                <member>
                  <name>name</name>
                  <value>
                    <string>未対応</string>
                  </value>
                </member>
                <member>
                  <name>id</name>
                  <value>
                    <i4>1</i4>
                  </value>
                </member>
              </struct>
            </value>
          </member>
          <member>
            <name>key</name>
            <value>
              <string>DORA-310</string>
            </value>
          </member>
          <member>
            <name>updated_on</name>
            <value>
              <string>20081106135234</string>
            </value>
          </member>
          <member>
            <name>summary</name>
            <value>
              <string>BacklogAPIで課題を登録してみる(1225945534)</string>
            </value>
          </member>
          <member>
            <name>issueType</name>
            <value>
              <struct>
                <member>
                  <name>name</name>
                  <value>
                    <string>バグ</string>
                  </value>
                </member>
                <member>
                  <name>id</name>
                  <value>
                    <i4>5</i4>
                  </value>
                </member>
                <member>
                  <name>color</name>
                  <value>
                    <string>#990000</string>
                  </value>
                </member>
              </struct>
            </value>
          </member>
          <member>
            <name>created_on</name>
            <value>
              <string>20081106132534</string>
            </value>
          </member>
          <member>
            <name>url</name>
            <value>
              <string>https://demo.backlog.jp/view/DORA-310</string>
            </value>
          </member>
          <member>
            <name>id</name>
            <value>
              <i4>250274</i4>
            </value>
          </member>
          <member>
            <name>milestones</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>date</name>
                        <value>
                          <string>21121010</string>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>
                          <string>お披露目パーティ</string>
                        </value>
                      </member>
                      <member>
                        <name>id</name>
                        <value>
                          <i4>5</i4>
                        </value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
          <member>
            <name>assigner</name>
            <value>
              <struct>
                <member>
                  <name>name</name>
                  <value>
                    <string>demo</string>
                  </value>
                </member>
                <member>
                  <name>id</name>
                  <value>
                    <string>2</string>
                  </value>
                </member>
              </struct>
            </value>
          </member>
          <member>
            <name>description</name>
            <value>
              <string>XML-RPCで課題を登録してみるテストです。
いわゆるBacklogAPIです。

詳細を追記します。</string>
            </value>
          </member>
          <member>
            <name>due_date</name>
            <value>
              <string>20081230000000</string>
            </value>
          </member>
          <member>
            <name>milestone</name>
            <value>
              <struct>
                <member>
                  <name>date</name>
                  <value>
                    <string>21121010</string>
                  </value>
                </member>
                <member>
                  <name>name</name>
                  <value>
                    <string>お披露目パーティ</string>
                  </value>
                </member>
                <member>
                  <name>id</name>
                  <value>
                    <i4>5</i4>
                  </value>
                </member>
              </struct>
            </value>
          </member>
          <member>
            <name>resolution</name>
            <value>
              <struct>
                <member>
                  <name>name</name>
                  <value>
                    <string>対応済み</string>
                  </value>
                </member>
                <member>
                  <name>id</name>
                  <value>
                    <i4>0</i4>
                  </value>
                </member>
              </struct>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

backlog.updateIssue｜API｜開発者向け｜どこでもプロジェクト管理バックログ

backlog.updateIssue

メソッド名

権限

パラメータ

カスタム属性形式が文字列、数値、日付の場合 (typeId=1,2,3,4)

カスタム属性形式がリストの場合 (typeId=5,6,7,8)

レスポンス

共通

カスタム属性形式が文字列、数値、日付の場合 (typeId=1,2,3,4)

カスタム属性形式が単一リスト、複数リストの場合 (typeId=5,6)

カスタム属性形式が上記以外の場合 (typeId=7,8)

リクエストXMLの例

レスポンスXMLの例

ＡＰＩメソッド

ツアー

Backlogを
使いこなそう

事例紹介

価格

サポート

開発者向け

その他

backlog.updateIssue｜API｜開発者向け｜どこでもプロジェクト管理バックログ

backlog.updateIssue

メソッド名

権限

パラメータ

カスタム属性形式が文字列、数値、日付の場合 (typeId=1,2,3,4)

カスタム属性形式がリストの場合 (typeId=5,6,7,8)

レスポンス

共通

カスタム属性形式が文字列、数値、日付の場合 (typeId=1,2,3,4)

カスタム属性形式が単一リスト、複数リストの場合 (typeId=5,6)

カスタム属性形式が上記以外の場合 (typeId=7,8)

リクエストXMLの例

レスポンスXMLの例

ＡＰＩメソッド

ツアー

Backlogを 使いこなそう

事例紹介

価格

サポート

開発者向け

その他

Backlogを
使いこなそう