REST API

ALM Octane is an entity-relationship application. Using the REST API, developers can retrieve and perform CRUD (create, read, update, delete) operations on the entities that are available in ALM Octane.

Tip: You can use the ALM Octane Developer Tools to analyze the ALM Octane entities and fields available in the REST API.

Public APIs

To access public resources, you do not need to send any additional headers. Only the content-type header is necessary.

For a list, see Public resources.

Back to top

Tips for API calls

The following guidelines can help you create effective API calls and improve performance.

  • Only specify the fields you need. Do not include fields that are not relevant.
  • Use a more selective query when fetching the data, to drill down to the results that you need. One way to do this is by using a filter, which can reduce the amount of data being fetched.

  • To read a complex data set that includes multiple entity types, for example a test and all of its last runs, we recommend that you perform the read operation from the “many” side of the relation between entities and not from the “few”. It is better to read all runs filtered by the test, where the run itself has a filter for the relevant tests, such as an ID or any other query. For example, the following query will return all last runs related to tests, where the tests themselves are linked to a specific application model: query: (is_test_last_run=true;(test={((product_areas={id=1004}))}))

  • When reading multiple entities together with a one-to-one relationship and applying a filter, we recommend filtering the main entity in order to reduce the amount of data.
  • It is preferable to not expand more than two or three fields per request. If responses are slow, try to split the request into two separate requests.
  • When possible, use an API key as the authentication method. LDAP may slow down the connection substantially when the number of requests increases. In general, it is recommended to use API keys for integrations, and not credentials belonging to real users, unless those LDAP users are dedicated users for integration.

Back to top

Technical Preview APIs

Technical preview resources are available for use. Users should be aware that they are subject to change until declared public.

To access these resources, send requests with a header:

  • Header: ALM-OCTANE-TECH-PREVIEW

  • Value: true

Back to top

See also: