Share this page

# What's changed in the REST API

This topic includes a comprehensive list of updates to the REST API and SDKs by version.

In this topic:

## Version 15.1.90

The following entities were moved from Public to Tech Preview access level: audit, history_log

Back to top

## Version 15.1.60

The following REST API changes are introduced in version 15.1.60:

Notice of upcoming changes

- In an upcoming release, the order field in the run_type entity will be deprecated.
- In an upcoming release, we will stop supporting injection of mixed results from both automated tests and Gherkin/BDD results in the same REST API request. If you need to do this, inject each type in a separate REST API request.

Access level changes

The following tables list access level changes for entities and fields.

The entities listed below are on the workspace level, unless noted otherwise.

Fields added to Public

The following fields were added to the Public access level:

Entity | Field
--- | ---
audit (workspace, site, and space levels) | 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 (workspace, site, and space levels) | 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

Fields removed from Public

The following fields were removed from the Public access level:

Entities | Field
audit(workspace, site, and space levels) | 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 (workspace, site, and space levels) | 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

Fields added to Tech Preview

The following field was added to the Tech Preview access level:

Entity | Fields
list_node | index

Fields removed from Tech Preview

The following fields were removed from the Tech Preview access level:

Entity | Fields
shared_resource | description, client_lock_stamp, version_stamp, subtype, creation_time, name, last_modified, id

Back to top

## Version 15.1.48

- In the test-results resource, we added the component field to test suites and suite runs. This enables you to tag a suite run by a component or characteristic that it is a member of, for example ALM-domain-project. For details, see test-results.

- We've added a new suite_runs method. For details, see Trigger a suite run (technical preview).

- There is a new tech preview API which supports adding SCM Data (repositories and commits) to ALM Octane. Note that a build context is required. For details, see Add SCM data into ALM Octane (technical preview).

Back to top

## Version 15.1.40

- A new tech preview API enables you to get referenced entities with selected fields returned by the REST API. For details, see Reference fields (technical preview).

- The site parameter ALLOW_SETTING_LIST_NODE_LOGICAL_NAME is deprecated. Instead of filtering lists by logical name, filter them by name.

You can use the REST API to retrieve details of CI servers connected to ALM Octane:

The request header to be used is ALM-OCTANE-TECH-PREVIEW: true

Within the API, set the URL (path) as:

`<protocol>://<hostname>:<port>/shared_spaces/<shared_space_id>/workspaces/<workspace_id>/ci_servers/configured`

The CI servers are returned as JSON objects. Example:

*** Response ***

[

{

"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"

}

]

Access level changes:

For this version, access levels were changed for popular entities and fields. The entities listed below are on the workspace level, unless specifically noted otherwise.

Fields added to Tech Preview

The following fields were added to the Tech Preview access level:

Entity | Fields
attachment | owner_bdd_spec
audit (workspace, site, and space levels) | 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 (workspace, site, and space levels) | 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

Fields added to Public

The following fields were added to the Public access level:

Entity | Field
session (site level) | user
test_suite_link_to_gherkin, test_suite_link_to_test | run_mode

Back to top

## Version 15.1.20

Limitation:

When requesting field metadata using public API resources, ALM Octane may not return target information, or may return empty target information, for fields that reference private entities. Such fields should be ignored as they are not part of the public API. This limitation will be resolved in the next version by not returning these fields at all.

Planned changes:

- For upcoming versions, the following fields will no longer be groupable:

  - test entity: Run, Contained Tests, and Link to test fields
  - run entity: Run steps field

- The run_steps resource is expected to be changed in a future release.

- In an upcoming release we will deprecate the site parameter ALLOW_SETTING_LIST_NODE_LOGICAL_NAME. Instead of filtering lists by logical name, filter them by name.

Access level changes:

For this version, access levels were changed for popular entities and fields. The entities listed below are on the workspace level, unless specifically noted otherwise.

Fields removed

The following field was removed:

Entities | Field
run_automated, run_suite | bdd_spec_name

Fields added to Tech Preview

The following fields were added to the Tech Preview access level:

Entity | Fields
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

Fields added to Public

The following field was added to the Public access level:

Entity | Field
context_parameter (site level) | value_source

Back to top

## Version 15.1.8

You can now inject test results in the context of a suite using the test_results resource. For details see test-results.

Access level changes:

For this version, access levels were changed for popular entities and fields.

Entities moved to Tech Preview

The following entities were moved from Private to Tech Preview access level:

data_set, test_data_table

Fields moved to Tech Preview

The following fields were moved from Private to the Tech Preview access level:

Entity | Fields
data_set | test_data_table
test_data_table | data

Fields moved to Public

The following field was moved from Private to the Public access level:

Entity | Fields
test_data_table | description

Fields added to Tech Preview

The following fields were added to the Tech Preview access level:

Entity | Fields
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

Back to top

## Version 15.1.4

For this version, access levels were changed for popular entities and fields.

Entities moved to Tech Preview

The following entities were moved from Private to Tech Preview access level:

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 (site level), 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

Entities moved to Public

The following entities were moved from Private or Tech Preview access level to Public:

gherkin_auomated_run, planning_info, test_automated, test_version

Fields moved to Tech Preview

The following fields were moved from Private to the Tech Preview access level:

Entity | Fields
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 (site level) | 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 (site level) | start_date, consumed, expiration_date, editions, license_type, capacity, license_model (new)
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 (space level) | 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 (site level) | is_alive
sharedspace_user (space level) | scm_users
shared_space (site level) | status, version
site_role (site level) | 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

Fields moved to Public

The following fields were moved from Private or Tech Review to the Public access level:

Entity | Fields
ci_build | status
ci_server | pipeline
context_parameter (site level) | modified_by
cycle_time | is_open
defect | fixed_on, covering_tests, dependence, depends_on, tasks_number, reopens, commits, metaphase (new)
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 (new)
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 (space level) | 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, (new), use_runtime_version (new), bdd_spec (new)
run_manual | linked_defects, latest_pipeline_run, test_[phase, test_version, product_areas, previous_release, use_runtime_version (new), bdd_spec (new)
run_suite | linked_defects, latest_pipeline_run, default_run_by, milestone, previous_release, external_run_id (new), use_runtime_version (new)
scenario_test | last_runs
session (site level) | license_edition, end_time, client_type, user, access_type, shared_space, session_identifier, client_ip
sharedspace_user (space level) | last_login, language, full_name
shared_space (site level) | mode
site_role (site level) | actions
site_user (site level) | 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 (new)
team_member | team, capacity
team_member_team_sprint |
test_automated | last_runs, external_test_id (new)
test_data_table | description
test | last_runs, external_test_id (new)
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 (new)

Back to top

## Version 15.0.60

The following API updates were made in version 15.0.60:

- Technical preview resources are now requested using the header: `ALM-OCTANE-TECH-PREVIEW`.

  Previously, the header contained underscores: ALM_OCTANE_TECH_PREVIEW

- The resource test_suite_link_to_manual_tests is deprecated for Gherkin tests.

  If you want to add, get, or update Gherkin tests in a suite, use the new resource: test_suite_link_to_gherkin_tests. (This resource is technical preview.)

New resources

More REST API resources are now available as a technical preview:

- pull-requests. Allows you to inject pull-requests into ALM Octane. For details, see Add pull requests into ALM Octane (technical preview).
- site_tags resource. Allows you to manage site tags in ALM Octane. For details, see Managing site tags.

Back to top

## Version 15.0.40

New resources

More REST API resources are now available as a technical preview:

- coverage. Allows you to inject coverage into ALM Octane. For details, see Add coverage into ALM Octane (technical preview).
- logs. Allows you to inject logs into ALM Octane. For details, see Add a log into ALM Octane (technical preview).

Back to top

## Version 15.0.20

No changes.

Back to top

See also:

- What's new in 15.1.90

https://admhelp.microfocus.com ALM Octane 8942
Tips to improve your search results... ALM Octane Help Center ALM Octane Help 15.1.90 All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: