REST APIの変更点
このトピックには、バージョンごとのRESTAPIおよびSDKの更新の包括的なリストが含まれています。
このトピックの内容:
- バージョン15.1.90
- バージョン15.1.60
- バージョン15.1.48
- バージョン15.1.40
- バージョン15.1.20
- バージョン15.1.8
- バージョン15.1.4
- バージョン15.0.60
- バージョン15.0.40
- バージョン15.0.20
バージョン15.1.90
次のエンティティがパブリックからTech Previewアクセスレベルに移動されました: audit、history_log
バージョン15.1.60
次のREST APIの変更は、バージョン15.1.60で導入されています。
今後の変更のお知らせ
- 今後のリリースでは、run_stepエンティティのorderフィールドは非推奨になります。
- 今後のリリースでは、自動テストとGherkin/BDD結果の両方からの混合結果の同じREST APIリクエストへの注入のサポートを停止します。これを行う必要がある場合は、各タイプを個別のREST APIリクエストに挿入します。
アクセスレベルの変更
次の表に、エンティティとフィールドのアクセスレベルの変更を示します。
以下にリストされているエンティティは、特に明記されていない限り、ワークスペースレベルです。
バージョン15.1.48
-
test-resultsリソースで、コンポーネントフィールドをテストスイートとスイートの実行に追加しました。ALMドメインプロジェクトメンバーであるコンポーネントまたは特性によって実行されるスイートにタグを付けることができます。詳細については、test-resultsを参照してください。
-
新しいsuite_runsメソッドを追加しました。詳細については、スイートの実行をトリガーする (テクニカルプレビュー)を参照してください。
-
ALM OctaneへのSCMデータ (リポジトリとコミット) の追加をサポートする新しい技術プレビューAPIがあります。ビルドコンテキストが必要であることに注意してください。詳細については、SCMデータをALM Octaneに追加する (テクニカルプレビュー)を参照してください。
バージョン15.1.40
-
新しいテクニカルプレビューAPIを使用すると、REST APIによって返される選択されたフィールドを持つ参照エンティティを取得できます。詳細については、参照フィールド (テクニカルプレビュー)を参照してください。
-
サイトパラメーターALLOW_SETTING_LIST_NODE_LOGICAL_NAMEは非推奨になりました。リストを論理名でフィルタリングする代わりに、名前でフィルタリングします。
あなたは、ALM Octaneに接続されているCIサーバの詳細を取得するためのREST APIを使用することができます。
使用する要求ヘッダーはALM-OCTANE-TECH-PREVIEW: trueです。
API内で、URL (パス) を次のように設定します。
<protocol>://<hostname>:<port>/shared_spaces/<shared_space_id>/workspaces/<workspace_id>/ci_servers/configured
CIサーバーはJSONオブジェクトとして返されます。例:
*** 応答 ***
[
{
"instanceId": "7a80500d-ed98-4cc5-ae6b-579b05e9f5ac",
"type": "teamcity",
"url": "http://myd-vma01001.swinfra.net:8090",
"sdkVersion": "2.6.3.22"
},
{
"instanceId": "c9fc44b2-0bc7-4a6e-a5f0-6658fc05dabc",
"type": "teamcity",
"url": "http://illokshin01.microfocus.com:8383",
"sdkVersion": "2.6.3.22"
}
]
アクセスレベルの変更:
このバージョンでは、人気のあるエンティティとフィールドのアクセスレベルが変更されました。以下にリストされているエンティティは、特に明記されていない限り、ワークスペースレベルです。
バージョン15.1.20
制限事項:
パブリックAPIリソースを使用してフィールドメタデータを要求する場合、ALM Octaneは、プライベートエンティティを参照するフィールドについて、ターゲット情報を返さないか、空のターゲット情報を返す場合があります。このようなフィールドはパブリックAPIの一部ではないため、無視する必要があります。この制限は、これらのフィールドをまったく返さないことにより、次のバージョンで解決される予定です。
計画された変更:
-
今後のバージョンでは、次のフィールドはグループ化できなくなります。
- testエンティティ: 実行、含まれるテスト、およびテストへのリンクフィールド
- runエンティティ: 実行ステップフィールド
-
run_stepsリソースは、将来のリリースで変更される予定です。
-
今後のリリースでは、サイトパラメーターALLOW_SETTING_LIST_NODE_LOGICAL_NAMEは非推奨になります。リストを論理名でフィルタリングする代わりに、名前でフィルタリングします。
アクセスレベルの変更:
このバージョンでは、人気のあるエンティティとフィールドのアクセスレベルが変更されました。以下にリストされているエンティティは、特に明記されていない限り、ワークスペースレベルです。
バージョン15.1.8
test_resultsリソースを使用して、スイートのコンテキストでテスト結果を挿入できるようになりました。詳細については、test-resultsを参照してください。
アクセスレベルの変更:
このバージョンでは、人気のあるエンティティとフィールドのアクセスレベルが変更されました。
バージョン15.1.4
このバージョンでは、人気のあるエンティティとフィールドのアクセスレベルが変更されました。
バージョン15.0.60
次のAPIアップデートがバージョン15.0.60で行われました。
-
テクニカルプレビューリソースは、ヘッダーを使用して要求されるようになりました。
ALM-OCTANE-TECH-PREVIEW
以前は、ヘッダーにアンダースコアが含まれていました。ALM_OCTANE_TECH_PREVIEW
-
リソースtest_suite_link_to_manual_testsは、Gherkinテストでは非推奨です。
スイートでGherkinテストを追加、取得、または更新する場合は、新しいリソースtest_suite_link_to_gherkin_testsを使用してください。(このリソースはテクニカルプレビューです。)
新しいリソース
より多くのRESTAPIリソースがテクニカルプレビューとして利用できるようになりました。
- プル要求。プル要求をALM Octaneに挿入できます。詳細については、プル要求をALM Octaneに追加する (テクニカルプレビュー)を参照してください。
- site_tagsリソース。ALM Octaneでサイトタグを管理できます。詳細については、サイトタグの管理を参照してください。
バージョン15.0.40
新しいリソース
より多くのRESTAPIリソースがテクニカルプレビューとして利用できるようになりました。
- カバレッジ。ALM Octaneにカバレッジを挿入できます。詳細については、ALM Octaneにカバレッジを追加する (テクニカルプレビュー)を参照してください。
- ログ。ALM Octaneにログを挿入できます。詳細については、ALM Octaneにログを追加する (テクニカルプレビュー)を参照してください。
バージョン15.0.20
変更はありません。
参照情報: