What's changed in the REST API

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

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.

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.

Back to top

Version 15.1.4

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

(missing or bad snippet)

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: 

Back to top

Version 15.0.40

New resources

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

Back to top

Version 15.0.20

No changes.

Back to top

See also: