子孫を含むドキュメントレポートの作成

このフローは、エンティティの子孫を含むREST APIを使用してドキュメントレポートを生成する方法を示しています。

概要

エンティティを操作するときは、エンティティの下に作成された子孫に関する情報を表示することが重要な場合がよくあります。

たとえば、特定のフィーチャーでのテスト実行を見ると、そのフィーチャーに直接関連する (そのフィーチャーに直接関連するテストを実行した) テスト実行が表示されます。ALM Octaneでは、ユーザーストーリーなど、フィーチャーエンティティの子孫に関連するテスト実行を表示することもできます。

ALM Octaneに、フィーチャーのテスト実行とそれに関連するユーザーストーリーの実行を表示するように指示できます。上記の例では、フィーチャーの子孫を含めるように指定すると、ユーザーストーリーに関連するテスト実行も返されます。

REST APIのinclude_all_descendantsフィールドは、分析およびレポートツールの子孫包含オプションに対応します。レポートに子孫を含めるには、フィールドをtrueに設定します。"include_all_descendants": true

以下の例では:

Feature A

> Test A

> run A

> Story B

> Test B

> run B

  • 子孫を含めない場合は、テスト実行Aのみが返されます。
  • 子孫を含めると、テスト実行AとBが返されます。

注: 子孫の包含は、work_item、test、requirement、applicationmoduleなどの階層エンティティにのみ関連します。

トップに戻る

例 - 直接的な関係を持つ階層エンティティ

次の例は、include_all_descendantsがtrueに設定されたPDF形式のドキュメントレポートの生成を示しています。work_itemエンティティの子孫をカバーするすべてのテストを返します。

{
   "document_type":"PDF",
   "document_orientation":"PORTRAIT",
   "timezone":"UTC+03:00",
   "file_name":"Octane_Doc_Report.pdf",
   "report_entries":[
      {
         "entity_name":"work_item",
         "fields":[
		"id", "name"
         ],
         "layout":"DETAILS",
         "report_entries":[
            {
               "entity_name":"test",
               "fields":[
            		"id", "name"
                ],
               "related_field_name":"test",
               "include_all_descendants":true,
               "layout":"DETAILS"
            }
         ]
      }
   ]
}

 

トップに戻る

参照情報: