REST APIの変更点

このトピックには、バージョンごとのRESTAPIおよびSDKの更新の包括的なリストが含まれています。

バージョン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リクエストに挿入します。

アクセスレベルの変更

次の表に、エンティティとフィールドのアクセスレベルの変更を示します。

以下にリストされているエンティティは、特に明記されていない限り、ワークスペースレベルです。

次のフィールドがパブリックアクセスレベルに追加されました。

エンティティ フィールド
audit (ワークスペース、サイト、およびスペースレベル) timestamp, user_id, workspace_user, session_id, action, user_name, change_set, field_name, entity_type, entity_physical_id, entity_id
epic milestone
gherkin_test link_to_test
history_log (ワークスペース、サイト、およびスペースレベル) timestamp, entity_type, session_id, action, es_id, workspace, change_set, field_name, user_name, user_id, entity_physical_id, entity_id
test, test_automated, test_manual link_to_test
test_suite_link_to_automated, test_suite_link_to_gherkin, test_suite_link_to_manual, test_suite_link_to_test test

次のフィールドがパブリックアクセスレベルから削除されました。

エンティティ

 フィールド
audit (ワークスペース、サイト、およびスペースレベル) es_id、modified_fields、request_id
business_rule is_system
environment description, id, last_modified, client_lock_stamp, name, creation_time, version_stamp
history_log (ワークスペース、サイト、およびスペースレベル) request_id, modified_fields
milestone release_specific
report_configuration show_author, show_date, logo, document_type, file_name, print_title_page, footer, title, header, print_toc, document_orientation
scenario_test, test_automated, test_suite modified_by
test_result_failure_notification_item linked_entity_requirement, linked_entity_work_item, linked_entity_work_item, linked_entity_task, linked_entity__test, linked_entity_linked_entity_process, linked_entity_pipeline, linked_entity_bdd_spec

次のフィールドがテクニカルプレビューアークセスレベルに追加されました。

エンティティ フィールド
list_node index

次のフィールドがテクニカルプレビューアークセスレベルから削除されました。

エンティティ フィールド
shared_resource description, client_lock_stamp, version_stamp, subtype, creation_time, name, last_modified, id

トップに戻る

バージョン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"

}

]

アクセスレベルの変更:

このバージョンでは、人気のあるエンティティとフィールドのアクセスレベルが変更されました。以下にリストされているエンティティは、特に明記されていない限り、ワークスペースレベルです。

次のフィールドがテクニカルプレビューアークセスレベルに追加されました。

エンティティ フィールド
attachment owner_bdd_spec

audit (ワークスペース、サイト、およびスペースレベル)

 request_id
comment owner_issue、owner_bdd_spec
defect, feature, quality_story, story, work_item cycle_time, wi_coverage
gherkin_test link_to_test
history_log (ワークスペース、サイト、およびスペースレベル) request_id
report_confirmation print_title_page, print_toc
scenario_test, test, test_automated, test_manual link_to_test
team_sprint team_member_team_sprints
test_suite_link_to_automated, test_suite_link_to_manual, test_suite_link_to_scenario, test_suite_link_to_test test

次のフィールドがパブリックアクセスレベルに追加されました。

エンティティ フィールド
session (サイトレベル) user
test_suite_link_to_gherkin、test_suite_link_to_test run_mode

トップに戻る

バージョン15.1.20

制限事項:

パブリックAPIリソースを使用してフィールドメタデータを要求する場合、ALM Octaneは、プライベートエンティティを参照するフィールドについて、ターゲット情報を返さないか、空のターゲット情報を返す場合があります。このようなフィールドはパブリックAPIの一部ではないため、無視する必要があります。この制限は、これらのフィールドをまったく返さないことにより、次のバージョンで解決される予定です。

計画された変更:

  • 今後のバージョンでは、次のフィールドはグループ化できなくなります。

    • testエンティティ: 実行、含まれるテスト、およびテストへのリンクフィールド
    • runエンティティ: 実行ステップフィールド

  • run_stepsリソースは、将来のリリースで変更される予定です。

  • 今後のリリースでは、サイトパラメーターALLOW_SETTING_LIST_NODE_LOGICAL_NAMEは非推奨になります。リストを論理名でフィルタリングする代わりに、名前でフィルタリングします。

アクセスレベルの変更:

このバージョンでは、人気のあるエンティティとフィールドのアクセスレベルが変更されました。以下にリストされているエンティティは、特に明記されていない限り、ワークスペースレベルです。

次のフィールドが削除されました。

エンティティ

 フィールド
run_automated, run_suite bdd_spec_name

次のフィールドがテクニカルプレビューアークセスレベルに追加されました。

エンティティ フィールド
comment is_reply, original_comment, shared
defect phase_age
epic phase_age
feature phase_age
gherkin_automated_run execution_parameters
pipeline, pipeline_run program
quality_story phase_age
run、run_automated execution_parameters, external_data_table
story phase_age, defects
test_suite_link_to_automated, test_suite_link_to_gherkin, test_suite_link_to_test execution_parameters

次のフィールドがパブリックアクセスレベルに追加されました。

エンティティ フィールド
context_parameter (サイトレベル) value_source

トップに戻る

バージョン15.1.8

test_resultsリソースを使用して、スイートのコンテキストでテスト結果を挿入できるようになりました。詳細については、test-resultsを参照してください。

アクセスレベルの変更:

このバージョンでは、人気のあるエンティティとフィールドのアクセスレベルが変更されました。

次のエンティティは、プライベートからテクニカルプレビューアークセスレベルに移動されました。

data_set、test_data_table

次のフィールドがプライベートからテクニカルプレビューアークセスレベルに移動されました。

エンティティ フィールド
data_set test_data_table
test_data_table data

次のフィールドがプライベートからパブリックアクセスレベルに移動されました。

エンティティ フィールド
test_data_table description

次のフィールドがテクニカルプレビューアークセスレベルに追加されました。

エンティティ フィールド
bdd_spec runs
business_rule is_system
defect, epic, feature, quality_story, story, work_item metaphase
gherkin_automated_run, run, run_manual bdd_spec
quality_story dependence, metaphase, depends_on
run_suite external_run_id
test_automated, test external_test_id

トップに戻る

バージョン15.1.4

このバージョンでは、人気のあるエンティティとフィールドのアクセスレベルが変更されました。

次のエンティティは、プライベートからテクニカルプレビューアークセスレベルに移動されました。

attachment_notification_item, attr_notification_item, auto_assign_notification_item, ci_parameter, code_base, code_coverage, code_file, comment_notification_item, commit_notification_item, commit_coverage, cycle_time, db_server (サイトレベル), entity_label, epic, executor, failed_test_notification_item, label, log_line, log_rule, notification_item, phase_notification_item, planning_info, plan_notification_item, ppr_failed_notification_item, report_notification_item, team_member_team_sprint, test_automated, uft_test_runner, wi_coverage

次のエンティティは、プライベートまたはテクニカルプレビューアークセスレベルからパブリックに移動されました。

gherkin_auomated_run, planning_info, test_automated, test_version

次のフィールドがプライベートからテクニカルプレビューアークセスレベルに移動されました。

エンティティ フィールド
attachment_notification_item linked_entity_task, linked_entity_test, linked_entity_requirement, linked_entity_bdd_spec, attachments, linked_entity_background_task, linked_entity_work_item, linked_entity_pipeline
attr_notification_item linked_entity_pipeline, linked_entity_requirement, linked_entity_work_item, linked_entity_bdd_spec, linked_entity_test, changed_fields, linked_entity_task, linked_entity_background_task
auto_assign_notification_item linked_entity_work_item, linked_entity_task, linked_entity_background_task , linked_entity_test, linked_entity_requirement, linked_entity_pipeline, linked_entity_bdd_spec
background_task followed_by_me
calendar_event calendar
calendar my_team
ci_parameter ci_build, value, type
ci_build build_fail_classification, tests_passed, execution, tests_failed, tests_skipped
ci_server executor
code_base repository
code_coverage covered_lines, pipeline, total_coverable_lines, total_scm_lines, scm_commit, pipeline_run
code_file scm_file_changes, code_base, file_path, defects
comment_notification_item linked_entity_task, linked_entity_requirement, linked_entity_pipeline, linked_entity_bdd_spec, linked_entity_test, linked_entity_background_task, linked_entity_work_item, comments
commit_notification_item commit_in_ppr, linked_entity_bdd_spec, linked_entity_pipeline, linked_entity_test, linked_entity_task, linked_entity_requirement, , linked_entity_background_task, linked_entity_work_item
commit_coverage covered_lines, scm_commit, total_coverable_lines, total_scm_lines, pipeline_run
db_server (サイトレベル) db_type, connection_string, is_alive, admin_password, admin_user
defect new_tasks, followed_by_me, assigned_to_me
entity_label initials, single_capitalized, language, single, plural, entity_type, plural_capitalized
epic followed_by_me, feature_count
executor scm_repository, run, tests, ci_server, test_suite_link, framework, job_name
failed_test_notification_item linked_entity_task, linked_entity_requirement, linked_entity_pipeline, linked_entity_bdd_spec, linked_entity_test, linked_entity_background_task, linked_entity_work_item, test_in_ppr
feature followed_by_me
gherkin_automated_run test_runner, steps_created
gherkin_test test_versions, test_runner, assigned_to_me, followed_by_me, testing_tool_type
label key, language, entity_type, entity_logical_name, methodology, value
license (サイトレベル) start_date, consumed, expiration_date, editions, license_type, capacity, license_model (新規)
list_node is_deletable, is_system, is_modifiable, is_rename_only
log_line job_name, log_text, ci_server_id, line_number, ci_build_id, rule, id
log_rule rule, log_line, build_classification
main_team_calendar my_team
notification_item ppr_id, oldest_id, latest_id, latest_milestone_id, oldest_milestone_id, latest_release_id, oldest_release_id, latest_sprint_id, oldest_sprint_id, linked_entity_task, linked_entity_requirement, linked_entity_pipeline, linked_entity_bdd_spec, linked_entity_test, linked_entity_background_task, linked_entity_work_item, commit_in_ppr, test_in_ppr, comments, status, changed_fields, attachments
phase_notification_item ppr_id, oldest_id, linked_entity_task, linked_entity_requirement, linked_entity_pipeline, linked_entity_bdd_spec, linked_entity_test, linked_entity_background_task, linked_entity_work_item
pipeline followed_by_me
pipeline_run issue
plan_notification_item latest_milestone_id, oldest_milestone_id, latest_release_id, oldest_release_id, latest_sprint_id, oldest_sprint_id, linked_entity_task, linked_entity_requirement, linked_entity_pipeline, linked_entity_bdd_spec, linked_entity_test, linked_entity_background_task, linked_entity_work_item
ppr_failed_notification_item linked_entity_task, linked_entity_requirement, linked_entity_pipeline, linked_entity_bdd_spec, linked_entity_test, linked_entity_background_task, linked_entity_work_item, ppr_id
quality_story assigned_to_me, followed_by_me, new_tasks
report_notification_item linked_entity_task, linked_entity_requirement, linked_entity_pipeline, linked_entity_bdd_spec, linked_entity_test, linked_entity_background_task, linked_entity_work_item, status
requirement_document assigned_to_me, followed_by_me
requirement assigned_to_me, followed_by_me
role (スペースレベル) actions
run_automated failed_since_pipeline,_run, discovered, test_runner, execution
run assigned_to_me, failed_since_pipeline_run, execution, ready
run_manual assigned_to_me, data_set
run_suite assigned_to_me, ready, default_taxonomies
scenario_test testing_tool_type, assigned_to_me, followed_by_me
server (サイトレベル) is_alive
sharedspace_user (スペースレベル) scm_users
shared_space (サイトレベル) status, version
site_role (サイトレベル) actions
space_calendar_event calendar
story assigned_to_me, followed_by_me, new_tasks, commits
task assigned_to_me, followed_by_me
team_calendar_event calendar
team working_days
team_sprint working_days
test_automated covered_manual_test, testing_tool_type, gherkin_test, executable, test_runner, scm_repostiory
test test_runner, assigned_to_me, followed_by_me, covered_manual_test, testing_tool_type, gherkin_test, executable, scm_repostiory, test_versions
test_manual testing_tool_type, test_versions, assigned_to_me, followed_by_me
test_runner ci_server, job_name, tests, framework, run, test_suite_link
test_suite followed_by_me, testing_tool_type
test_suite_link_to_automated test_runner, taxonomies
test_suite_link_to_gherkin run_by, run_mode, test_runner, test, taxonomies
test_suite_link_to_manual taxonomies, run_by, data_set
test_suite_link_to_scenario taxonomies
test_suite_link_to_test test_runner, data_set, taxonomies, run_mode
test_version bdd_spec
uft_executor scm_repository, job_name, run, framework, ci_sever
uft_test_runner scm_repository, job_name, test_suite_link, ci_server, run, framework, tests
wi_coverage pipeline, total_scm_lines, covered_lines, total_coverable_lines
workspace_calendar_event calendar
workspace_user audits, history_logs
work_item new_tasks, assigned_to_me, followed_by_me, feature_count

次のフィールドは、プライベートまたはテクニカルレビューからパブリックアクセスレベルに移動されました。

エンティティ フィールド
ci_build status
ci_server pipeline
context_parameter (サイトレベル) modified_by
cycle_time is_open
defect fixed_on, covering_tests, dependence, depends_on, tasks_number, reopens, commits, metaphase (新規)
feature covering_tests, quality_stories, dependence, depends_on
gherkin_automated_run cluster, execution, pipeline, error_details, error_message, build, test_framework, full_error_details, latest_pipeline, milestone, failed_since_build, failed_since_build_info, error_type, failed_build_age, linked_defects, test_version, product_areas, bdd_spec (新規)
gherkin_test last_runs
metaphase order
pipeline_run milestone, release, pipeline, user_tags, scm_commits
planning_info sprint, release, milestone
quality_story tasks_number, commits, metaphase
role (スペースレベル) is_system, customizable
run_automated milestone, build, product_areas, latest_pipeline_run, custom_report_link, cluster, linked_defects, pipeline
run previous_release, linked_defects, build, latest_pipeline_run, custom_report_link, test_version, product_areas, pipeline, cluster, test_phase, external_run_id, (新規), use_runtime_version (新規), bdd_spec (新規)
run_manual linked_defects, latest_pipeline_run, test_[phase, test_version, product_areas, previous_release, use_runtime_version (新規), bdd_spec (新規)
run_suite linked_defects, latest_pipeline_run, default_run_by, milestone, previous_release, external_run_id (新規), use_runtime_version (新規)
scenario_test last_runs
session (サイトレベル) license_edition, end_time, client_type, user, access_type, shared_space, session_identifier, client_ip
sharedspace_user (スペースレベル) last_login, language, full_name
shared_space (サイトレベル) mode
site_role (サイトレベル) actions
site_user (サイトレベル) language, first_name, roles, password, ldap_dn, gdpr_consent_time, full_name, ldap_server_id, phone1, last_login, last_name, email
story covering_tests, depends_on, dependence, tasks_number, commits, metaphase (新規)
team_member team, capacity
team_member_team_sprint  
test_automated last_runs, external_test_id (新規)
test_data_table description
test last_runs, external_test_id (新規)
test_manual last_runs、covering_automated_test
test_suite last_runs
test_suite_link_to_automated include_in_next_run
test_suite_link_to_gherkin include_in_next_run
test_suite_link_to_manual include_in_next_run
test_suite_link_to_scenario include_in_next_run
test_suite_link_to_test include_in_next_run
test_version script, comment, test, is_external, releases, creator
user_item reason, my_follow_items_test,my_follow_items_requireemnt, my_follow_items_task, my_follow_items_work_items, my_follow_items_run, user, entity_type
workspace_user language, full_name
workspace (space level) working_days, current_release, description
work_item tasks_number, detected_by, suite_run, covering_tests, fixed_on, depends_on, dependence, quality_stories, reopens, qa_owner, commits, metaphase (新規)

トップに戻る

バージョン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リソースがテクニカルプレビューとして利用できるようになりました。 

トップに戻る

バージョン15.0.40

新しいリソース

より多くのRESTAPIリソースがテクニカルプレビューとして利用できるようになりました。 

トップに戻る

バージョン15.0.20

変更はありません。

トップに戻る

参照情報: