The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Cisco Unified Communications Domain Manager API is versioned and while the latest API and models are in use, the system is backwards compatible with earlier API versions for a number of models and operations on these. This means that API requests follow the schema and data as specified by the API version.
Third party clients that are written to use a particular API version should continue to work against newer servers as long as the Cisco Unified Communications Domain Manager server continues to support the API version used by the client. Cisco Unified Communications Domain Manager supports APIs from the current release and two previous releases (N-2).
The API Version is represented in major.minor.revision format, for example: 10.1.2 or 10.6.1.
"meta": { "tags": [], "pkid": "", "schema_version": "0.1", "hierarchy": "sys", "version_tag": "0.2", "api_version": "10.6.1", "model_type": "data/DataModel" },
The supported HTTP methods on models from the API are:
Support for backwards compatibility was introduced in 10.6(1) release.
Third party API clients must specify the api_version when integrating with Cisco Unified Communications Domain Manager 10.6(1). This is required if the third party client wants to make use of backwards compatibility, since it ensures the client continues to receive consistent schemas. Specifying the API version can be done in one of two ways.
GET http://localhost/api/data/Countries/?hierarchy=[hierarchy] &schema=true&format=json&api_version=10.6.1The Query Parameter approach is the recommended method for a client to specify the API Version.
GET http://localhost/api/data/Countries/?hierarchy=[hierarchy] &schema=true&format=json Request headers X-Version: 10.6.1
The 10.1(2) release is not backwards compatible with the 10.1(1) release.
There are some differences in customer facing models in release 10.6.(1) with respect to the previous release, 10.1(2). These differences are captured in the following document.
show hcs hil target apiversion - To get the current API version of target system
set hcs hil target apiversion - To set the API version of target system
Note | If there are any active HIL sessions, CLI will prompt the number of active sessions and will check for confirmation before changing the API version |