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

メソッド名

backlog.admin.updateCustomField

権限

「管理者」権限が必要です。

パラメータ

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

カスタム属性形式によってリクエストが一部変わりますのでご注意ください。

共通

backlog.admin.updateCustomFieldパラメータ

パラメータ名	型	内容
id (必須)	int	カスタム属性ID
name (必須)	string	カスタム属性名
issueTypes (必須)	int または int の Array	指定した課題種別でカスタム属性を有効にします。 空の場合、すべての課題種別で有効になります。
description	string	カスタム属性説明
required	boolean	1: 必須属性 0: 任意属性

カスタム属性形式が数値の場合 (typeId=3)

backlog.admin.updateCustomField数値パラメータ

パラメータ名	型	内容
min	double	最小値
max	double	最大値
initial_value	double	初期値
unit	string	単位

カスタム属性形式が日付の場合 (typeId=4)

backlog.admin.updateCustomField日付パラメータ

パラメータ名	型	内容
initial_value_type	int	初期表示種別 1 : 当日 2 : 当日 + initial_shift 3 : 指定日
initial_shift	int	当日+差分日数 (初期表示種別=2のとき有効)
initial_date	string	初期表示日(YYYYMMDD) (初期表示種別=3のとき有効)
min	string	開始日(YYYYMMDD)
max	string	終了日(YYYYMMDD)

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

backlog.admin.updateCustomField単一、複数リストパラメータ

パラメータ名	型	内容
items		リスト項目一覧
└ name	string	項目名

カスタム属性形式がチェックボックス、ラジオボタンの場合 (typeId=7,8)

backlog.getCustomFields チェックボックス、ラジオボタンレスポンスフィールド

パラメータ名	型	内容
allow_input	boolean	その他直接入力を許可 1 : true 0 : false
items		リスト項目一覧
└ name	string	項目名

レスポンス

カスタム属性structを返します。
カスタム属性structの各フィールドの意味は下記の通りです。

カスタム属性形式によってレスポンスが一部変わりますのでご注意ください。

共通

backlog.getCustomFields 共通レスポンスフィールド

フィールド	説明	例
id	カスタム属性ID	4
typeId	カスタム属性形式	カスタム属性形式種別 1 : 文字列 2 : 文章 3 : 数値 4 : 日付 5 : 単一リスト 6 : 複数リスト 7 : チェックボックス 8 : ラジオ
name	カスタム属性名	OS
description	カスタム属性説明	現象が発生したOS
required	必須属性項目 1 : true 0 : false	1
issueTypes	課題種別一覧
├ id	種別ID	5
├ name	種別名	バグ
└ color	種別色	#990000

カスタム属性形式が数値の場合 (typeId=3)

backlog.getCustomFields 数値レスポンスフィールド

フィールド	説明	例
min	最小値	0.0
max	最大値	100.0
initial_value	初期値	0.0
unit	単位	%

カスタム属性形式が日付の場合 (typeId=4)

backlog.getCustomFields 日付レスポンスフィールド

フィールド	説明	例
initial_value_type	初期表示種別 1 : 当日 2 : 当日 + initial_shift 3 : 指定日	1
initial_shift	当日+差分日数(初期表示種別=2のとき有効)	7
initial_date	初期表示日(初期表示種別=3のとき有効)	20110302
min	開始日	20110302
max	終了日	20110309

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

backlog.getCustomFields 単一、複数リストレスポンスフィールド

フィールド	説明	例
items	リスト項目一覧
├ id	種別ID	1
└ name	項目名	Windows

カスタム属性形式がチェックボックス、ラジオボタンの場合 (typeId=7,8)

backlog.getCustomFields チェックボックス、ラジオボタンレスポンスフィールド

フィールド	説明	例
allow_input	その他直接入力を許可 1 : true 0 : false	1
items	リスト項目一覧
├ id	種別ID	1
└ name	項目名	Windows

リクエストXMLの例

<?xml version="1.0" ?>
<methodCall>
  <methodName>backlog.admin.updateCustomField</methodName>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>id</name>
            <value>
              <i4>18</i4>
            </value>
          </member>
          <member>
            <name>required</name>
            <value>
              <boolean>1</boolean>
            </value>
          </member>
          <member>
            <name>name</name>
            <value>
              <string>OS</string>
            </value>
          </member>
          <member>
            <name>issueTypes</name>
            <value>
              <array>
                <data>
                  <value>
                    <i4>1</i4>
                  </value>
                </data>
              </array>
            </value>
          </member>
          <member>
            <name>items</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>name</name>
                        <value>
                          <string>Windows</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                  <value>
                    <struct>
                      <member>
                        <name>name</name>
                        <value>
                          <string>Mac</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                  <value>
                    <struct>
                      <member>
                        <name>name</name>
                        <value>
                          <string>Linux</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodCall>

レスポンスXMLの例

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>id</name>
            <value>
              <i4>18</i4>
            </value>
          </member>
          <member>
            <name>issueTypes</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <i4>1</i4>
                        </value>
                      </member>
                      <member>
                        <name>color</name>
                        <value>#990000</value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>バグ</value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
          <member>
            <name>items</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <i4>0</i4>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>Windows</value>
                      </member>
                    </struct>
                  </value>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <i4>1</i4>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>Mac</value>
                      </member>
                    </struct>
                  </value>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <i4>2</i4>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>Linux</value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
          <member>
            <name>description</name>
            <value></value>
          </member>
          <member>
            <name>name</name>
            <value>OS</value>
          </member>
          <member>
            <name>required</name>
            <value>
              <boolean>1</boolean>
            </value>
          </member>
          <member>
            <name>type_id</name>
            <value>
              <i4>5</i4>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>