Developer Guide

Applies to QAComplete 14.5, last modified on August 06, 2024

QAComplete and ALMComplete have a set of APIs for data access and integrations with external systems. The APIs are available to both SaaS and On-Premises customers.

In this documentation, we refer to both QAComplete and ALMComplete collectively as QAComplete.

QAComplete has both REST and SOAP APIs.

Data dictionary

QAComplete Data Dictionary

The data dictionary describes basic tables, views, and fields for each major feature of QAComplete.

REST APIs

You use REST APIs to access data in QAComplete and to integrate automated testing tools with QAComplete Test Management.

The latest version of the data access REST API is v1. The latest version of the test automation REST API is v2.

Data Access REST API

Using this API, you can create, load, update and delete items of different types in QAComplete.

About REST API

An API overview and usage notes.

How To

Sample requests for common tasks.

Reference

All resources and operations.

Test Automation REST API

Using the test automation REST API, you can create agents that will run on test hosts and handle communication between QAComplete and the automated testing tool. An example of an agent is the Test Agent for TestComplete.

REST API Overview

API overview and usage notes.

Create Test Agents

Describes the Test Agent workflow and how to implement it using the REST API.

Reference

All operations, their parameters, and data formats.

SOAP API

The SOAP API provides access to data in QAComplete – defects, tests, releases, requirements, agile tasks, and other items. Using this API, you can create, load, update, and delete items in QAComplete, import and export items, and synchronize them with third-party systems you use.

SOAP API Overview

API overview and usage notes.

How To

Ready code examples for typical tasks.

Reference

All operations, their parameters, and data formats.

Note: Since release 10.2, a number of SOAP API methods are obsolete and are supported for backward compatibility only. Please, consider using REST API methods to access the QAComplete data.

See Also

User Guide
Administrator Guide

Highlight search results