backlog.getCustomFields
プロジェクトに登録してあるカスタム属性の情報を取得します。
マックスプランで利用することができます。
メソッド名
backlog.getCustomFields
パラメータ
structの要素に下記パラメータが指定できます。
| パラメータ名 | 型 | 内容 |
|---|---|---|
| projectId(必須) | int | プロジェクトID (例：5) |
| issueTypeId または issueType | issueTypeId は int または array、 issueType は string または array |
種別ID または 種別名 (種別はgetIssueTypesで取得できます) |
レスポンス
カスタム属性structのarrayを返します。
カスタム属性structの各フィールドの意味は下記の通りです。
カスタム属性形式によってレスポンスが一部変わりますのでご注意ください。
共通
| フィールド | 説明 | 例 |
|---|---|---|
| id | カスタム属性ID | 4 |
| type_id | カスタム属性形式 |
カスタム属性形式種別 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 |
カスタム属性形式が数値の場合 (type_id=3)
| フィールド | 説明 | 例 |
|---|---|---|
| min | 最小値 | 0.0 |
| max | 最大値 | 100.0 |
| initial_value | 初期値 | 0.0 |
| unit | 単位 | % |
カスタム属性形式が日付の場合 (type_id=4)
| フィールド | 説明 | 例 |
|---|---|---|
| initial_value_type |
初期表示種別 1 : 当日 2 : 当日 + initial_shift 3 : 指定日 |
1 |
| initial_shift | 当日+差分日数(初期表示種別=2のとき有効) | 7 |
| initial_date | 初期表示日(初期表示種別=3のとき有効) | 20110302 |
| min | 開始日 | 20110302 |
| max | 終了日 | 20110309 |
カスタム属性形式が単一、複数リストの場合 (type_id=5,6)
| フィールド | 説明 | 例 |
|---|---|---|
| items | リスト項目一覧 | |
| ├ id | 種別ID | 1 |
| └ name | 項目名 | Windows |
カスタム属性形式がチェックボックス、ラジオボタンの場合 (type_id=7,8)
| フィールド | 説明 | 例 |
|---|---|---|
| allow_input |
その他直接入力を許可 1 : true 0 : false |
1 |
| items | リスト項目一覧 | |
| ├ id | 種別ID | 1 |
| └ name | 項目名 | Windows |
リクエストXMLの例
<?xml version="1.0" encoding="utf-8"?>
<methodCall>
<methodName>backlog.getCustomFields</methodName>
<params>
<param>
<value>
<struct>
<member>
<name>project_id</name>
<value>
<int>12</int>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodCall>レスポンスXMLの例
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>id</name>
<value>
<i4>3</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>allow_input</name>
<value>
<boolean>1</boolean>
</value>
</member>
<member>
<name>items</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>id</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>name</name>
<value>IE</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>id</name>
<value>
<i4>2</i4>
</value>
</member>
<member>
<name>name</name>
<value>Firefox</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>id</name>
<value>
<i4>3</i4>
</value>
</member>
<member>
<name>name</name>
<value>Safari</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>id</name>
<value>
<i4>4</i4>
</value>
</member>
<member>
<name>name</name>
<value>Chrome</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>id</name>
<value>
<i4>5</i4>
</value>
</member>
<member>
<name>name</name>
<value>Opera</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>description</name>
<value></value>
</member>
<member>
<name>name</name>
<value>ブラウザ</value>
</member>
<member>
<name>required</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>type_id</name>
<value>
<i4>8</i4>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
