OData for developers

ALM Octane supports OData (Open Data Protocol), the OASIS REST-based standard for accessing data. You can use OData to extend and improve reporting capabilities, above and beyond the functionality provided by ALM Octane dashboard widgets. This topic provides instructions for working with OData and ALM Octane.

Overview

This overview describes the use cases for developers to use the OData standard to access ALM Octane.

Developers can retrieve ALM Octane data over OData in several ways: 

Directly, by querying with an API client.

Connect to ALM Octane's OData support using basic authentication. For details, see Basic authentication.

Access the data. For details, see Accessing ALM Octane data using OData with a REST client.

Then use OData resources to work with ALM Octane data. For details, see the OData documentation.

By designing applications to integrate with ALM Octane over OData.

Connect to ALM Octane's OData support using basic authentication. For details, see Basic authentication.

Then use OData resources to work with ALM Octane data. For details, see the OData documentation.

Note: Only GET requests are supported when working with OData.

Back to top

Supported OData versions

ALM Octane supports OData version 2.0.

Back to top

Prerequisites

Request that the site admin or space admin activate basic authentication for each space with the SUPPORTS_BASIC_AUTHENTICATION configuration parameter.

Back to top

The ALM Octane server base URI

The ALM Octane server base URI for accessing ALM Octane data using OData is: 

<https://<server> /odata/v2/shared_spaces/<space_ID>/workspaces/<workspace_ID>/

Troubleshooting: If ALM Octane does not respond successfully to an OData consumer request, it might be because the base URL used to refer to ALM Octane is different than expected. Consider modifying ODATA_USE_SERVER_BASE_URL and SERVER_BASE_URL as described under Setting configuration parameters with the REST API or Set configuration parameters.

Back to top

Accessing ALM Octane data using OData with a REST client

The section describes how to access ALM Octane data using OData with a REST client.

Authenticating

To work with OData, review the prerequisites for basic authentication under Prerequisites, and then authenticate with basic authentication.

Caution: Activating basic authentication enables external systems to access ALM Octane using this authentication method, not just OData.

You can authenticate with either:

  • Your user name and password.

  • An API access key.

For details, see Basic authentication.

Tip: When working with basic authentication, on each successful authentication, ALM Octane includes the LWSSO_COOKIE_KEY cookie in the response. We recommend that you send the LWSSO_COOKIE_KEY cookie with each subsequent OData request for enhanced performance. For details, see the information about the LWSSO_COOKIE_KEY under the topic Authenticating.

Retrieving ALM Octane data

You can use OData to retrieve ALM Octane data, but you cannot update (POST, PUT, DELETE) ALM Octane data. Only GET operations are supported.

By default, a maximum of 1000 items are returned.

Example: To see all defects: GET <base_URI>/defects

Back to top

Using OData options and operators for refined results

This version of ALM Octane currently supports the following URI conventions:

Options

$select, $filter, $orderby, $top, $count, $paging, $skip, $format, $expand, $link & $count, and returning the raw value.

$filter operators

Logical operators: eq, ne, gt, ge, lt, le, and, or, not, ( )

Filtering with logical operators on entities that have associations is not always supported.

Functions

String functions: bool substringof, bool endswith, bool startwith

See also: