このページを共有

# タスクボードを外部で管理する

このフローは、REST APIを使用してタスクボード上のタスクを管理する方法を示しています。

エリア: 作業項目、タスク

このトピックの内容:

## エンティティ関連図

このフローでは、次のエンティティにアクセスし、これらのエンティティ間の関係を理解する必要があります。

エンティティ | このフローの関係 | 関係の説明 | 参照 /関係フィールド
--- | --- | --- | ---
作業項目 | エピック、フィーチャー、不具合、ユーザーストーリー、品質ストーリー | この集約リソースコレクションは、エピック、フィーチャー、不具合、ユーザーストーリー、品質ストーリーなど、作業項目のタイプを表します。 | subtype
タスク | 作業項目はタスクに関連付けることができます。 | child_task
リリース | 作業項目はリリースに関連付けることができます。 | release
タスク | 作業項目 | タスクは、1つの品質ストーリー、ユーザーストーリー、または不具合に関連付ける必要があります。 タスクは、エピックやフィーチャーなどの他の作業項目に関連付けることはできません。 ユーザーストーリー、品質ストーリー、および不具合は、複数のタスクに関連付けることができます。 | story defect
フェーズ | タスクはフェーズに関連付ける必要があります。 | phase
ユーザー | タスクには1人の所有者が必要です。 | owner
リストノード | 各タスクのタイプは、list_nodeリソースコレクションを照会することで参照できます。 | item_type
エピック | 作業項目 | エピックはwork_itemsのサブタイプです。 集約リソースコレクションwork_itemsに関連するフィールドはありません。 |
フィーチャー | エピックはフィーチャーに関連付けることができます。 |
フィーチャー | 作業項目 | フィーチャーはwork_itemsのサブタイプです。 集約リソースコレクションwork_itemsに関連するフィールドはありません。 |
エピック | フィーチャーはエピックに関連付けることができます。 | parent
ストーリーと不具合 | フィーチャーは、ユーザーストーリー、品質ストーリー、および不具合に関連付けることができます。 |
ユーザーストーリー | 作業項目 | ユーザーストーリーは、work_itemsのサブタイプです。 集約リソースコレクションwork_itemsに関連するフィールドはありません。 |
フィーチャー | ユーザーストーリーはフィーチャーに関連付けることができます。 | parent
不具合 | ユーザーストーリーは不具合に関連している可能性があります。 |
品質ストーリー | 作業項目 | 品質ストーリーは、work_itemsのサブタイプです。 集約リソースコレクションwork_itemsに関連するフィールドはありません。 |
フィーチャー | 品質ストーリーはフィーチャーに関連付けることができます。 | parent
不具合 | 品質ストーリーは不具合と関連している可能性があります。 |
不具合 | 作業項目 | 不具合はwork_itemsのサブタイプです。 集約リソースコレクションwork_itemsに関連するフィールドはありません。 |
フィーチャー | 不具合はフィーチャーに関連付けることができます。 | parent
ストーリー | 不具合はストーリーに関連付けることができます。 |
フェーズ | フィーチャー、品質ストーリー、ユーザーストーリー、および不具合 | フィーチャー、品質ストーリー、ユーザーストーリー、および不具合は、フェーズに関連付ける必要があります。 | phase
ユーザー | すべての作業項目 | エピック、フィーチャー、品質ストーリー、ユーザーストーリー、および不具合は、所有者に関連付けることができます。 | owner
リリース | すべての作業項目 | エピック、フィーチャー、品質ストーリー、ユーザーストーリー、および不具合は、所有者に関連付けることができます。 | release
スプリント | スプリントはリリースに関連付けられています。 | release

トップに戻る

## フロー: リリース、スプリント、およびチームの作業項目タスクを取得、作成、および更新します

このフローの目標は、特定のリリース、スプリント、およびチームに割り当てられた作業項目のすべてのタスクを取得することです。

ステップバイステップでREST API呼び出しを作成しましょう。

1. 最初のステップとして、すべての作業項目をリストします。

   `GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/work_items`

2. 作業項目が多い場合は、ストーリーをID番号 (order_by=id) で並べ替えて、id、name、team、release、sprint、subtype、およびchild_tasks。

   subtypeは、ワーク項目が不具合やユーザーストーリーなどのエンティティであるかどうかを示します。

   child_tasksは、ワーク項目がタスクに関連付けられているかどうかを示します。

   `GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/work_items?order_by=id&fields=id,name,team,release,sprint,subtype,child_tasks`

   応答

       {
           "total_count": 14,
           "data": [
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "5ge4jg0m29olmukp11l05qn7m",
                   "subtype": "story",
                   "release": {
                       "type": "release",
                       "activity_level": 0,
                       "name": "Release2",
                       "id": "1002"
                   },
                   "sprint": {
                       "type": "sprint",
                       "end_date": "2018-07-14T12:00:00Z",
                       "name": "Sprint 1",
                       "id": "1008",
                       "start_date": "2018-07-01T12:00:00Z"
                   },
                   "name": "Access credit history",
                   "id": "1013",
                   "team": {
                       "type": "team",
                       "name": "Processers",
                       "id": "1001"
                   }
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "k3wxj59g07oz9tnx77lpg62vg",
                   "subtype": "story",
                   "release": {
                       "type": "release",
                       "activity_level": 0,
                       "name": "Release1",
                       "id": "1001"
                   },
                   "sprint": {
                       "type": "sprint",
                       "end_date": "2018-04-11T12:00:00Z",
                       "name": "Sprint 1",
                       "id": "1001",
                       "start_date": "2018-03-29T12:00:00Z"
                   },
                   "name": "Access public prison records",
                   "id": "1012",
                   "team": {
                       "type": "team",
                       "name": "Processers",
                       "id": "1001"
                   }
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "0nrzq94z3ml10ax1zgx7nj48g",
                   "subtype": "defect",
                   "release": {
                       "type": "release",
                       "activity_level": 0,
                       "name": "Release2",
                       "id": "1002"
                   },
                   "sprint": {
                       "type": "sprint",
                       "end_date": "2018-07-14T12:00:00Z",
                       "name": "Sprint 1",
                       "id": "1008",
                       "start_date": "2018-07-01T12:00:00Z"
                   },
                   "name": "Approval letters went out to rejected customers if customer was under 50 and had an account at our bank",
                   "id": "1016",
                   "team": {
                       "type": "team",
                       "name": "Processers",
                       "id": "1001"
                   }
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "owlkqogl702xohdw5eoxrjy81",
                   "subtype": "feature",
                   "release": null,
                   "sprint": null,
                   "name": "Approval process",
                   "team": null,
                   "id": "1009"
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "work_item.root",
                   "subtype": "work_item_root",
                   "release": null,
                   "sprint": null,
                   "name": "Backlog",
                   "team": null,
                   "id": "1001"
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "d79yjmn2v78kfne3y0mw6wpo4",
                   "subtype": "story",
                   "release": {
                       "type": "release",
                       "activity_level": 0,
                       "name": "Release3",
                       "id": "1003"
                   },
                   "sprint": null,
                   "name": "Check if customer ever filed bankcruptcy",
                   "id": "1014",
                   "team": {
                       "type": "team",
                       "name": "Processers",
                       "id": "1001"
                   }
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "5ge4jg08wk3mns9lng1n8qn7m",
                   "subtype": "defect",
                   "release": {
                       "type": "release",
                       "activity_level": 0,
                       "name": "Release2",
                       "id": "1002"
                   },
                   "sprint": {
                       "type": "sprint",
                       "end_date": "2018-07-28T12:00:00Z",
                       "name": "Sprint 2",
                       "id": "1009",
                       "start_date": "2018-07-15T12:00:00Z"
                   },
                   "name": "Could not log into prison service app",
                   "id": "1015",
                   "team": {
                       "type": "team",
                       "name": "Processers",
                       "id": "1001"
                   }
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "r482j2xlkvvo9alpelvxk6oex",
                   "subtype": "feature",
                   "release": null,
                   "sprint": null,
                   "name": "Credit and background checks",
                   "team": null,
                   "id": "1011"
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "5x8ljxv018r95uk83ovrm67r9",
                   "subtype": "epic",
                   "release": null,
                   "sprint": null,
                   "name": "Foreclosures",
                   "team": null,
                   "id": "1008"
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "eo4wqw8dgnld1hywkxwggqgvz",
                   "subtype": "feature",
                   "release": null,
                   "sprint": null,
                   "name": "Policy terms and rates",
                   "team": null,
                   "id": "1010"
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "3zxeql5r78w8gaxyg11rg6vm4",
                   "subtype": "epic",
                   "release": null,
                   "sprint": null,
                   "name": "Processing",
                   "team": null,
                   "id": "1007"
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "xeyrqzmlexm4gi4w9zxmw6z1g",
                   "subtype": "epic",
                   "release": null,
                   "sprint": null,
                   "name": "Realtors",
                   "team": null,
                   "id": "1006"
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "4v9xj0xpvzm5nbo40dkwkj71z",
                   "subtype": "epic",
                   "release": null,
                   "sprint": null,
                   "name": "Sales",
                   "team": null,
                   "id": "1005"
               },
               {
                   "type": "work_item",
                   "workspace_id": 1002,
                   "logical_name": "lv9w63zv5gkw4h3738g38j40m",
                   "subtype": "story",
                   "release": {
                       "type": "release",
                       "activity_level": 0,
                       "name": "Release2",
                       "id": "1002"
                   },
                   "sprint": {
                       "type": "sprint",
                       "end_date": "2018-07-28T12:00:00Z",
                       "name": "Sprint 2",
                       "id": "1009",
                       "start_date": "2018-07-15T12:00:00Z"
                   },
                   "name": "Verify realtor's credentials and track record",
                   "id": "1017",
                   "team": {
                       "type": "team",
                       "name": "Realtors",
                       "id": "1002"
                   }
               }
           ],
           "exceeds_total_count": false
       }

3. ここで、query句を使用して、タスクを表示するリリース、スプリント、およびチームのIDを指定します。私たちの場合、私たちは見たいです:

   - IDが1002のRelease2

   - IDが1009のSprint 2

   - IDが1002の全米リアルター協会加入者

   ユーザーストーリー、不具合、品質ストーリーのタスクを確認したいので、OR演算子を使用してこれらのサブタイプによってもクエリを実行することに注意してください。エピックやフィーチャーなど、他の作業項目は見たくありません。

   `GET .../api/shared_spaces/<space_id>/work_items?fields=name,tasks_number,owner,id, release,sprint,team&query="(release={id=1002};sprint={id=1009};team={id=1002};(subtype='story'||subtype='defect'||subtype='quality_story'))"`

   このリリース、スプリント、チームの組み合わせには、ユーザーストーリー1017という1つの作業項目しかありません。

   応答

       {
           "total_count": 1,
           "data": [
               {
                   "type": "work_item",
                   "owner": null,
                   "workspace_id": 1002,
                   "logical_name": "lv9w63zv5gkw4h3738g38j40m",
                   "tasks_number": 3,
                   "subtype": "story",
                   "release": {
                       "type": "release",
                       "activity_level": 0,
                       "name": "Release2",
                       "id": "1002"
                   },
                   "sprint": {
                       "type": "sprint",
                       "end_date": "2018-07-28T12:00:00Z",
                       "name": "Sprint 2",
                       "id": "1009",
                       "start_date": "2018-07-15T12:00:00Z"
                   },
                   "name": "Verify realtor's credentials and track record",
                   "id": "1017",
                   "team": {
                       "type": "team",
                       "name": "Realtors",
                       "id": "1002"
                   }
               }
           ],
           "exceeds_total_count": false
       }

4. このストーリーの既存のタスクを見てみましょう。

   `GET .../api/shared_spaces/<space_id>/tasks？query="story ={id EQ ^ 1017 ^}"`

   このストーリーには3つのタスクがあります。

   応答

       {
           "total_count": 3,
           "data": [
               {
                   "type": "task",
                   "owner": null,
                   "creation_time": "2018-03-29T13:09:19Z",
                   "phase": {
                       "type": "phase",
                       "activity_level": null,
                       "logical_name": "phase.task.new",
                       "name": "New",
                       "index": 100,
                       "id": "phase.task.new"
                   },
                   "version_stamp": 1,
                   "item_type": null,
                   "release": "Release2",
                   "author": {
                       "type": "workspace_user",
                       "activity_level": 0,
                       "full_name": "Marta Berman",
                       "name": "marta",
                       "id": "1002"
                   },
                   "description": null,
                   "remaining_hours": 0,
                   "workspace_id": 1002,
                   "invested_hours": 0,
                   "is_draft": false,
                   "name": "Check accreditation and licensing database",
                   "estimated_hours": 0,
                   "progress": "{\"storyId\":1011,\"tasksInvestedHoursSumTotal\":0,\"tasksEstimatedHoursSumTotal\":0,\"tasksRemainingHoursSumTotal\":0}",
                   "id": "1011",
                   "last_modified": "2018-03-29T13:09:19Z",
                   "story": {
                       "type": "story",
                       "name": "Verify realtor's credentails and track record",
                       "id": "1017"
                   }
               },
               {
                   "type": "task",
                   "owner": null,
                   "creation_time": "2018-03-29T13:09:19Z",
                   "phase": {
                       "type": "phase",
                       "activity_level": null,
                       "logical_name": "phase.task.new",
                       "name": "New",
                       "index": 100,
                       "id": "phase.task.new"
                   },
                   "version_stamp": 1,
                   "item_type": null,
                   "release": "Release2",
                   "author": {
                       "type": "workspace_user",
                       "activity_level": 0,
                       "full_name": "Marta Berman",
                       "name": "marta",
                       "id": "1002"
                   },
                   "description": null,
                   "remaining_hours": 0,
                   "workspace_id": 1002,
                   "invested_hours": 0,
                   "is_draft": false,
                   "name": "List references",
                   "estimated_hours": 0,
                   "progress": "{\"storyId\":1012,\"tasksInvestedHoursSumTotal\":0,\"tasksEstimatedHoursSumTotal\":0,\"tasksRemainingHoursSumTotal\":0}",
                   "id": "1012",
                   "last_modified": "2018-03-29T13:09:19Z",
                   "story": {
                       "type": "story",
                       "name": "Verify realtor's credentails and track record",
                       "id": "1017"
                   }
               },
               {
                   "type": "task",
                   "owner": null,
                   "creation_time": "2018-03-29T13:09:19Z",
                   "phase": {
                       "type": "phase",
                       "activity_level": null,
                       "logical_name": "phase.task.new",
                       "name": "New",
                       "index": 100,
                       "id": "phase.task.new"
                   },
                   "version_stamp": 1,
                   "item_type": null,
                   "release": "Release2",
                   "author": {
                       "type": "workspace_user",
                       "activity_level": 0,
                       "full_name": "Marta Berman",
                       "name": "marta",
                       "id": "1002"
                   },
                   "description": null,
                   "remaining_hours": 0,
                   "workspace_id": 1002,
                   "invested_hours": 0,
                   "is_draft": false,
                   "name": "Resume attachment feature",
                   "estimated_hours": 0,
                   "progress": "{\"storyId\":1010,\"tasksInvestedHoursSumTotal\":0,\"tasksEstimatedHoursSumTotal\":0,\"tasksRemainingHoursSumTotal\":0}",
                   "id": "1010",
                   "last_modified": "2018-03-29T13:09:19Z",
                   "story": {
                       "type": "story",
                       "name": "Verify realtor's credentails and track record",
                       "id": "1017"
                   }
               }
           ],
           "exceeds_total_count": false
       }

5. このストーリーに新たなタスクを加えてみましょう。

                                       POST .../api/shared_spaces/<space_id>/tasks

       {"data":
          [
             {   "item_type":
                       {"type":"list_node",
                        "id":"list_node.task_item_type.test"},
                 "phase":
                       {"type":"phase",
                       "id":"phase.task.new"},
                 "story":
                       {"type":"work_item",
                       "id":"1017"},
                 "owner":
                       {"type":"workspace_user",
                       "id":"1003"},
                 "name":"Test that it all works."
             }
          ]
       }

   ID 1013のタスクが作成されました。

   応答

   コード201 Createdが返されます。

       {
           "total_count": 1,
           "data": [
               {
                   "type": "task",
                   "id": "1013"
               }
           ],
           "exceeds_total_count": false
       }

6. この新しく作成されたストーリー1013のいくつかのフィールドを更新しましょう。名前を変更し、所有者を変更し、フェーズを更新し、タスクにすでに費やされた時間数を定義します。

       PUT.../api/shared_spaces/<space_id>/tasks/1013

       {

           "name":"Check that the background check matches a manual check.",
           "owner":{"type":"workspace_user","id":"1005"},
           "invested_hours":10,
           "phase":{"type":"phase","id":"phase.task.inprogress"},
           "id":"1013"

       }

   ID 1013のタスクが作成されました。

   応答

   コード200が返されます。

       {

           "type": "task",

           "id": "1013"

       }

トップに戻る

参照情報:

- REST APIの操作方法
- 一般的なフローとERダイアグラム

https://admhelp.microfocus.com ALM Octane 8942
検索結果を改善するためのヒント... ALM Octaneヘルプセンター ALM Octaneヘルプ 15.1.90 すべて ローカルヘルプセンターを表示 オンラインヘルプセンターを表示 戻る ブラウザーの履歴内を戻る 進む ブラウザーの履歴内を進む 検索のハイライトを削除する 次のトピック 次のトピックに進む 前のトピック 前のトピックに戻る 現在のトピックを印刷 バージョン: