ALM REST API Reference (Deprecated) Overview

Using the REST API, you can create a client application that creates, reads, updates, and deletes data on the ALM (Application Lifecycle Management) platform. Without any coding, you can also use a browser as your client to read information from ALM.

The REST API is for use by programmers familiar with RESTful API technology.

Before working with this API, read the General Notes and Limitations.

Before working with data, the user must be authenticated (logged on) and a session opened.

Data is available as instance and collection resources. An instance is a complete functional unit of information. Instances are members of collections. An instance is identified by the collection it belongs to and its ID. For example, ../defects/23.

Most data is passed and returned in JSON format. Some resources support or require other formats. The resource-specific details are in each resource's reference page. To specify the format for the return value, use an Accept header. To specify the format for submitted data, use a Content-Type header. The header value is usually application/json.

When getting a collection, the results can be filtered, ordered, and grouped by different fields. See Collections.

The data is returned in pages. The client application must request each page. The first page is returned by the first GET. See Data Paging.

Changing  data:

  • An instance is created with a POST on a collection.
  • An existing instance is changed with a PUT operation on the specific entity.
  • An instance is deleted with a DELETE on the specific entity.

For more detail on changing data, see Instances.

In addition to entity and entity collection resources, there are general resources such as:

  • utility resources such as attachments, locks, and so on
  • general resources that apply to the whole site, to all collections, or to the session

List of Resources

See REST Resources in this API

See Also