What's new in the REST API

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

Version 16.0.200

The following REST API changes are introduced in version 16.0.200:

  • Default fields are not returned for TECH-PREVIEW resources.

Version 16.0.100

The following REST API changes are introduced in version 16.0.100:

  • The following release process entities are exposed as technical previews: process, release_process, release_stage, process_group, process_action, process_quality_gate, user_input_criterion, query_criterion

  • Injection of mixed results from automated tests and Gherkin/BDD results is no longer supported in the same REST API request. If you need to do this, inject each type in a separate REST API request.

  • The recycled_item entity is no longer available.

  • The executable field in the test and test_automated entities is no longer available.

Notice of upcoming changes

Starting in version 16.0.200, there will be a limit to the number of records you can receive when fetching the run entity as follows:

  • If you order by id, creation_time, or start, and your filter generates more than 2,000 results, results will be returned correctly but total_count will be 2,000. The exceeds_total_count will be true, indicating that there are more results than the given total.

  • If you order by other fields and your filter generates more than 2,000 results, you may receive an error message telling you to refine your filter or to order by id, creation_time, or start.

Back to top

See also: