Comment on page

Version

Ativo REST API endpoints and models are versioned

REST endpoints version
The current REST API is version 1, and is in beta. 
Data model version
Any script using the API should be cautious and check for data model version changes. 
Ativo Programs for Jira evolves continuously. Adding new functionalities causes the configuration objects evolve as well. 
The current data model version is 7.
Non-breaking changes are added on a continuous basis. This typically means new data fields or data objects are created. A non-breaking data model change will not cause the version to change.
Breaking changes are added on a regular basis. This typically means:
The format of a field changes
A field is renamed
A field is removed
The data model version is increased when a breaking change is released.
Data model REST endpoint 
Use the following REST endpoint to check if the data model version still corresponds with the model version your script is supporting. 
get
https://cloud-api.ativo.io
/rest/api/1/meta/model/version
Get the API model version
Version header
The data model version is added as a X-API-Model-Version header to any API response. Example:
HTTP/1.1 200 
X-API-Model-Version: 7

REST API - Previous

Authentication

Next - REST API

Cloud REST API

Last modified 1mo ago