フィールドの選択

このセクションでは、ALM Octane REST APIによって返されるフィールドの選択に関する情報を提供します。

概要

コレクションに対するGET操作への応答で、サーバーから返されるフィールドを指定できます。

多くの場合、パフォーマンス上の理由から、標準設定でリストされていない特定のフィールドを取得する場合は、fields句を使用すると便利です。標準設定で返されないフィールドの例としては、ユーザー定義フィールド、コメント、添付ファイル、実行、および実行ステップがあります。

トップに戻る

fieldsパラメーター

fieldsパラメーターでフィールドを選択します。fieldsパラメーターの構文は次のとおりです。 

fields=<field name>[[,<field name>]]

  • 選択したフィールドに関係なく、フィールドのIDとタイプは常に返されます。

  • フィールド名はコンマで区切ります。 ,

  • 目的のフィールド名を明示的に指定せずにエンティティをリクエストすると、次のフィールドのみが返されます:id、workspace_id、type、subtype、およびlogical_name。

トップに戻る

例

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects?fields=id,name

{
    "total_count": 3,
    "data": [
        {
            "type": "defect",
            "name": "Emptying out items in cart takes way too long",
            "id": "1014"
        },
        {
            "type": "defect",
            "name": "Shortcut key for deleting all items in cart does not work.",
            "id": "1012"
        },
        {
            "type": "defect",
            "name": "When adding one item to cart, it appears as if the item was added two times.",
            "id": "1013"
        }
    ],
    "exceeds_total_count": false
}

パフォーマンスを最適化するために、エンティティをGETする場合、コメントは応答に含まれません。コメントを表示するには、fields句を使用してコメントを明示的にリクエストする必要があります。

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects?fields=comments

トップに戻る

参照フィールド (テクニカルプレビュー)

エンティティの参照フィールドを取得することもできます。

たとえば、要件とそれに関連するテストを取得するとします。上記のパブリックAPIを使用すると、応答にはエンティティのID (要件)、参照されるエンティティのID (関連するテスト)、およびそのタイプ (手動テストなど) が含まれます。

テクニカルプレビューAPIでは、IDとタイプに加えて、参照されるエンティティに対して返されるフィールドを指定できます。たとえば、要件に関連付けられているテストの名前とステータスを取得できます。

このAPIは、最大3レベルまで再帰的です。つまり、参照フィールドの参照フィールドをリクエストできます。たとえば、要件、それに関連するテスト、テストのアプリケーションモジュール、およびそれらのアプリケーションモジュールのフィールドを要求できます。

注: APIは、パブリックプレビューまたはテクニカルプレビューである選択可能なフィールドのみを返します。

APIは、保存されているすべてのデータを1つのリクエストでフェッチするようには設計されていません。ほとんどの場合、直接参照されるエンティティのデータをフェッチするために使用する必要があります。

例:

  • GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects?fields=id,name,release{id,name,start_date,end_date}

  • GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects?fields=id,name,team{id,name, team_lead{id,full_name,email}}

トップに戻る

参照情報: