/
REST Integration API Evolution
REST Integration API Evolution
ServiceBroker Release API Information
Throughout the API documentation, there are two locations where ServiceBroker release version numbers are listed:
- At the top of every REST API page is a single ServiceBroker release version number in green, for example: 5.0.0
- This number indicates the ServiceBroker release in which the API was introduced.
- So, for example, a 5.0.0 version number listed on the top of an API page indicates that the API was introduced in version 5.0.0 of ServiceMobility.
- Users of ServiceBroker running a version prior to the indicated introduced version on an API will need to upgrade to at least the listed version to be able to use the API in any integration with ServiceBroker.
- At the top of some REST API pages are one or more ServiceBroker release version numbers in yellow, for example: 5.1.0
- These numbers indicates the ServiceBroker releases in which the API was changed.
- So, for example, a 5.1.0 version number listed on the top of an API page indicates that the API was changed in version 5.1.0 of ServiceBroker.
- Users of ServiceBroker upgrading to a new version where they integrate with APIs that have changed will need to review the changes to that API, to ensure that their integration remains compatible following on from an upgrade.
- In the description of some object properties there may be a single ServiceBroker release version number in grey, for example: 5.1.0
- This number indicates the ServiceBroker release in which the relevant property was added to the existing object.
- So, for example, a 5.1.0 version number listed in the description of a property on an API page indicates that the relevant property was introduced in version 5.1.0 of ServiceBroker.
- Users of ServiceBroker running a version prior to the indicated introduced version on an object property will need to upgrade to at least the listed version to be able to use the object property in any integration with ServiceBroker.
, multiple selections available,
Related content
REST API Evolution
REST API Evolution
More like this
REST Integration Best Practices
REST Integration Best Practices
More like this
RESTified APIs
RESTified APIs
More like this