REST API Guide | 2019.2

What's new

Helix ALM REST API 2019.2 includes the following key features and enhancements. For a complete list, check out the release notes.

Note:  For detailed information about REST API resources and response objects with examples, see the interactive help for the current version.

Work with custom fields

You can now work with the most commonly used types of custom fields. You can get, create, update, reorder, and delete custom fields.

Work with field relationships

You can now get, create, update, and delete field relationships to configure dependencies between dropdown fields.

Work with test variants

You can now get, create, update, reorder, and delete test variants, which are used when describing test cases and generating test runs. When test runs are generated, a test run is created for each unique combination of test variants, such as operating systems, databases, or client types.

Get version information

You can now get version information about the REST API Server, Helix ALM Server, and the communications library used to connect to the Helix ALM Server, which can help when troubleshooting. The versions of each module and any error information is returned. See API versions and compatibility with Helix ALM versions.