backlog.findIssue
指定した条件に該当する課題を返します。
メソッド名
backlog.findIssue
パラメータ
structの要素に下記パラメータが指定できます。
| パラメータ名 | 型 | 内容 |
|---|---|---|
| projectId (必須) | int | プロジェクトID (例：5) |
| issueTypeId または issueType | issueTypeId は int または array、 issueType は string または array |
種別ID または 種別名 (種別はgetIssueTypesで取得できます) |
| componentId | int または array |
カテゴリID (例：5) カテゴリが未設定のものを含める場合「-1」 (カテゴリはgetComponentsで取得できます) |
| versionId | int または array |
発生バージョンID (例：5) 発生バージョンが未設定のものを含める場合「-1」 (発生バージョンはgetVersionsで取得できます) |
| milestoneId | int または array |
マイルストーンID (例：5) マイルストーンが未設定のものを含める場合「-1」 (マイルストーンはgetVersionsで取得できます) |
| statusId | int または array |
状態ID 1 : 未対応 2 : 処理中 3 : 処理済み 4 : 完了 |
| priorityId | int または array |
優先度 2 : 高 3 : 中 4 : 低 |
| assignerId | int または array |
担当者ユーザID 担当者が未設定のものを含める場合「-1」 (プロジェクト参加ユーザはgetUsersで取得できます) |
| createdUserId | int または array |
登録者ユーザID
(プロジェクト参加ユーザはgetUsersで取得できます) |
| resolutionId | int または array |
完了理由ID -1 : 未設定 0 : 対応済み 1 : 対応しない 2 : 無効 3 : 重複 4 : 再現しない |
| created_on_min | string | 課題の登録日 範囲開始日(YYYYMMDD) |
| created_on_max | string | 課題の登録日 範囲終了日(YYYYMMDD) |
| updated_on_min | string | 課題の更新日 範囲開始日(YYYYMMDD) |
| updated_on_max | string | 課題の更新日 範囲終了日(YYYYMMDD) |
| start_date_min | string | 課題の開始日 範囲開始日(YYYYMMDD) (プレミアムプラン以上で指定可) |
| start_date_max | string | 課題の開始日 範囲終了日(YYYYMMDD) (プレミアムプラン以上で指定可) |
| due_date_min | string | 課題の期限日 範囲開始日(YYYYMMDD) |
| due_date_max | string | 課題の期限日 範囲終了日(YYYYMMDD) |
| query | string | 検索キーワード |
| sort | string |
並び順 ISSUE_TYPE : 種別 SUMMARY : 件名 STATUS : 状態 PRIORITY : 優先度 CREATED : 登録日時 UPDATED: 更新日時 DUE_DATE : 期限日 |
| order | boolean |
昇順または降順 true : 昇順 false : 降順 |
| offset | int | 取得する検索結果のオフセット値 |
| limit | int | 取得する検索結果の課題数(0〜100) |
レスポンス
課題structのarrayを返します。
課題structの各フィールドの意味は下記の通りです。
| フィールド | 説明 | 例 |
|---|---|---|
| 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 | 種別名 | タスク |
| 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 |
リクエストXMLの例
projectId = 1, milestoneId = [5, 6], limit = 2 の場合
<?xml version="1.0" encoding="utf-8"?>
<methodCall>
<methodName>backlog.findIssue</methodName>
<params>
<param>
<value>
<struct>
<member>
<name>projectId</name>
<value>
<int>1</int>
</value>
</member>
<member>
<name>milestoneId</name>
<value>
<array>
<data>
<value>
<int>5</int>
</value>
<value>
<int>6</int>
</value>
</data>
</array>
</value>
</member>
<member>
<name>limit</name>
<value>
<int>2</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>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>20081106135201</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>
</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 />
</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>
<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>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>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>description</name>
<value>
<string>XML-RPCで課題を登録してみるテストです。
いわゆるBacklogAPIです。</string>
</value>
</member>
<member>
<name>key</name>
<value>
<string>DORA-312</string>
</value>
</member>
<member>
<name>updated_on</name>
<value>
<string>20081106133423</string>
</value>
</member>
<member>
<name>due_date</name>
<value>
<string>20081230000000</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>
</struct>
</value>
</member>
<member>
<name>summary</name>
<value>
<string>BacklogAPIで課題を登録してみる(1225946062)</string>
</value>
</member>
<member>
<name>created_on</name>
<value>
<string>20081106133423</string>
</value>
</member>
<member>
<name>url</name>
<value>
<string>https://demo.backlog.jp/view/DORA-312</string>
</value>
</member>
<member>
<name>milestone</name>
<value>
<struct>
<member>
<name>date</name>
<value>
<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>id</name>
<value>
<i4>250283</i4>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>ＡＰＩメソッド
