Open topic with navigation
This topic includes a comprehensive list of updates to the REST API by version.
REST API work items (epics, features, user stories, and defects) can now be created as drafts.
Business rules are bypassed when POSTing drafts of work items. Business rule validation is enforced, however, when editing (PUTting) these work items.
For details, see Working with draft entities.
You can now filter on all the properties of the entity metadata. To create complex filters, use the following operators:
You can specify multiple clauses in the filter, such as:
The following changes may require updates to your existing REST API calls:
|Entity||Field||Change||New value||Old value|
More REST API entities (and their fields) are now publicly available:
CI servers and builds
As would be expected, you cannot update non-public fields for public entities when performing POST and PUT operations.
Announcing the public REST API!
Certain REST API entities (and their fields) are now publicly available. This means that these entities:
Are fully supported.
Can be accessed without sending a special client type in REST API requests.
Are exposed in the interactive API client.
The public, supported entities include:
Common entities, such as list nodes
Epics, features, user stories, and defects
Application modules (product areas)
Workspaces, workspace roles, and workspace users
Phases (statuses) and transitions
Shared space roles and users
Accessing public entities and fields by getting metadata is now publicly available. Only public REST API entities and fields are listed when GETting the metadata for an entity.
Some REST API entities and fields that are not yet officially supported are still considered technical preview. These entities can be accessed using the HPECLIENTTYPE header with a value of HPE_REST_API_TECH_PREVIEW when sending REST API requests.
Interactive API client
You no longer have to be a shared space admin to access the interactive API client. All users can access it.
The interactive API client is now available from the Help menu . It used to be available from the API tab in Settings.
Authentication for the interactive API client is now separate from the ALM Octane authentication. That means that even if you are logged into ALM Octane, you are not automatically logged into the interactive API client.
You now need API Access client and secret keys to work with the interactive API client.
The minimum and maximum values for the Integer data type for metadata fields have changed:
Old values: -9223372036854775808 to +9223372036854775807
New values: -9007199254740991 to +9007199254740991