Backlog 旧API(XML−RPC)

backlog.createIssue

課題を追加します。
追加に成功した場合は、追加された課題が返ります。

メソッド名

backlog.createIssue

権限

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

パラメータ

structの要素に下記パラメータが指定できます。

backlog.createIssueパラメータ
パラメータ名 内容
projectId (必須)int課題を追加するプロジェクトID
summary (必須)string課題の件名
parent_issue_idint親課題のID
(有料プランで利用可)
descriptionstring課題の詳細
start_datestring開始日(YYYYMMDD)
(プレミアムプラン以上で指定可)
due_datestring期限日(YYYYMMDD)
estimated_hoursdouble予定時間(hour)

0.00〜999.00で指定できます。
(プレミアムプラン以上で指定可)
actual_hoursdouble実績時間(hour)

0.00〜999.00で指定できます。
(プレミアムプラン以上で指定可)
issueTypeId または issueType issueTypeId は int、
issueType は string
種別ID または 種別名

(種別はgetIssueTypesで取得できます)

未指定の場合、指定プロジェクトの1番目の種別になります。
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 または priorityint または string 優先度ID または 優先度名

2 : 高
3 : 中
4 : 低

未指定の場合は「中」になります。
assignerIdint 担当者ユーザID

(プロジェクト参加ユーザはgetUsersで取得できます)
custom_fields array(struct) カスタム属性に登録するパラメータ一覧(マックスプランで指定可)

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

カスタム属性形式が文字列、数値、日付の場合 (typeId=1,2,3,4)
backlog.createIssue 共通レスポンスフィールド
パラメータ名 内容
├ idintカスタム属性ID
└ valuesstringカスタム属性値

カスタム属性形式がリストの場合 (typeId=5,6,7,8)
backlog.createIssue 共通レスポンスフィールド
パラメータ名 内容
├ idint対象とするカスタム属性ID
├ other_textstring選択肢以外の任意の文字列

(その他が入力可能なリストのみ有効)
└ valuesint または array(int)リストの項目 ID

レスポンス

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

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

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

共通
backlog.findIssue 共通レスポンスフィールド
フィールド 説明
custom_fieldsカスタム属性Array(struct)
├ idカスタム属性ID4
├ 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.createIssue</methodName>
      <params>
        <param>
          <value>
            <struct>
              <member>
                <name>priority</name>
                <value>
                  <string>高</string>
                </value>
              </member>
              <member>
                <name>projectId</name>
                <value>
                  <int>1</int>
                </value>
              </member>
              <member>
                <name>due_date</name>
                <value>
                  <int>20081230</int>
                </value>
              </member>
              <member>
                <name>issueType</name>
                <value>
                  <string>バグ</string>
                </value>
              </member>
              <member>
                <name>summary</name>
                <value>
                  <string>BacklogAPIで課題を登録してみる(1225947152)</string>
                </value>
              </member>
              <member>
                <name>milestone</name>
                <value>
                  <string>お披露目パーティ</string>
                </value>
              </member>
              <member>
                <name>description</name>
                <value>
                  <string>XML-RPCで課題を登録してみるテストです。
    いわゆるBacklogAPIです。</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>高</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>demo</value>
                    </member>
                    <member>
                      <name>id</name>
                      <value>2</value>
                    </member>
                  </struct>
                </value>
              </member>
              <member>
                <name>milestones</name>
                <value>
                  <array>
                    <data>
                      <value>
                        <struct>
                          <member>
                            <name>date</name>
                            <value>21121010</value>
                          </member>
                          <member>
                            <name>name</name>
                            <value>お披露目パーティ</value>
                          </member>
                          <member>
                            <name>id</name>
                            <value>
                              <i4>5</i4>
                            </value>
                          </member>
                        </struct>
                      </value>
                    </data>
                  </array>
                </value>
              </member>
              <member>
                <name>status</name>
                <value>
                  <struct>
                    <member>
                      <name>name</name>
                      <value>未対応</value>
                    </member>
                    <member>
                      <name>id</name>
                      <value>
                        <i4>1</i4>
                      </value>
                    </member>
                  </struct>
                </value>
              </member>
              <member>
                <name>description</name>
                <value>XML-RPCで課題を登録してみるテストです。
    いわゆるBacklogAPIです。</value>
              </member>
              <member>
                <name>key</name>
                <value>DORA-313</value>
              </member>
              <member>
                <name>updated_on</name>
                <value>20081106135233</value>
              </member>
              <member>
                <name>due_date</name>
                <value>20081230000000</value>
              </member>
              <member>
                <name>issueType</name>
                <value>
                  <struct>
                    <member>
                      <name>name</name>
                      <value>バグ</value>
                    </member>
                    <member>
                      <name>id</name>
                      <value>
                        <i4>5</i4>
                      </value>
                    </member>
                    <member>
                      <name>color</name>
                      <value>#990000</value>
                    </member>
                  </struct>
                </value>
              </member>
              <member>
                <name>summary</name>
                <value>BacklogAPIで課題を登録してみる(1225947152)</value>
              </member>
              <member>
                <name>created_on</name>
                <value>20081106135233</value>
              </member>
              <member>
                <name>url</name>
                <value>https://demo.backlog.jp/view/DORA-313</value>
              </member>
              <member>
                <name>milestone</name>
                <value>
                  <struct>
                    <member>
                      <name>date</name>
                      <value>21121010</value>
                    </member>
                    <member>
                      <name>name</name>
                      <value>お披露目パーティ</value>
                    </member>
                    <member>
                      <name>id</name>
                      <value>
                        <i4>5</i4>
                      </value>
                    </member>
                  </struct>
                </value>
              </member>
              <member>
                <name>id</name>
                <value>
                  <i4>250291</i4>
                </value>
              </member>
            </struct>
          </value>
        </param>
      </params>
    </methodResponse>