Comment on page
Ativo REST API endpoints and models are versioned
The current REST API is version
1, and is in beta.
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
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.
Use the following REST endpoint to check if the data model version still corresponds with the model version your script is supporting.
Get the API model version
The data model version is added as a
X-API-Model-Versionheader to any API response. Example: