Platform

Changes to REST API

New extensions to the OpenAir REST API.

This release includes the following REST API enhancements:

• New Resources, Endpoints and Methods

• Expansion Support for Project Stage Names

New Resources, Endpoints and Methods

The following resources are now available:

• Customer — See Customers and Customer object properties.

• User — See Users and User object properties.

The following endpoints and methods are now available:

• GET​ /customers/ — See Get the List of Customers

• GET​ /customers/{id} — See Get a Customer

• OPTIONS /customers/ — See Discover Available Methods and Fetch the Endpoint Reference for Customers

• GET​ /users/ — See Get the List of Users

• GET​ /users/{id} — See Get a User

• OPTIONS /users/ — See Discover Available Methods and Fetch the Endpoint Reference for Users

The following endpoint and methods are also available if the Business Intelligence Connector feature is enabled in your company's account. See also REST API Endpoint for Published Reports

• GET​ /published-reports/ — See Get the List of Published Reports

• GET​ /published-reports/{id} — See Get a Published Report

Expansion Support for Project Stage Names

Read the project stage name as an expanded object.

The projectStageId attribute is available for expansion to obtain the project stage name when retrieving project data. The response includes expanded projectStageName objects.

The projectStageName object is available only as an expanded object and has the following attributes:

Property	Description	Type
id	The unique internal identifier of the project stage.	integer($int64)
name	The name of the project stage.	string

For more information about the Expansion feature, see Referenced Objects and Expansion.