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.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_step 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.

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.

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.

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.

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: 

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: