The 10.0 release of Cisco Unified Communication Manager will not support the 7.x AXL schemas.
      Developers must upgrade to a supported AXL schema (8.x, 9.x or 10.0).
      View Latest Schema

 

AXL Versioning Support

The Administration XML (AXL) interface supports multiple AXL schema versions which provide an abstraction layer between AXL Applications and the Unified CM database. Use of AXL Versioning enables Developers to support multiple Unified CM releases and maintain backward compatibility during Customer upgrades.

Developers can specify the schema that they wish to use in the SOAP Action Header of the request.
If a schema version is not specified, the oldest supported schema will be used. The AXL versioning guidelines are illustrated in the following table and explained below.

    Release 8.6(x) did not include a new schema. Developers should use the 8.5 schema with Release 8.6(x).
      All new 8.6 database objects have been added to the 9.0 schema in Release 9.0(1)

AXL Guidelines (beginning with Unified 10.0)

  • Developers should always plan to implement support for the newest AXL schema available.
  • AXL schemas will be available for two major Unified CM release cycles.
  • New AXL schemas will be added in each Unified CM major and minor release (e.g. N.N.n).
  • Old AXL schemas will only be deprecated in the first major (N.n.n) release of Unified CM. This means that upon the first major release of a UCM version (N.n.n), all schemas for the N-3 major and minor releases (N-3.*.*) will be deprecated and removed.
    For Example:
    • Cisco Unified CM 10.0 supports AXL schemas for 8.x, 9.x, and 10.0, while the 7.x schemas are deprecated and removed.
    • Cisco Unified CM 11.0 supports AXL schemas for 9.x, 10.x, and 11.0, while the 8.x schemas are deprecated and removed.
  • Maintenance releases never include new AXL schemas (e.g. n.n.N).
  • Developers should always specify the desired AXL schema version in the SOAPAction Header to ensure the desired schema is applied to the request.
  • Developers who do not request a specific AXL schema will always connect to the oldest schema available.
  • Use of the executeSQLQuery and executeSQLUpdate interfaces provide no backward compatibility between Unified CM releases. Cisco recommends Developers avoid using these interfaces, as they bypass the schema abstraction layer and interoperate with the database schema directly. Applications which make use of these interfaces may break when the database schema changes. Cisco reserves the right to change the database schema in any release, at any time, for any reason, without any notice.

AXL Guidelines (Unified CM 6.x through 9.x)

  • AXL schemas will be available for two major Unified CM release cycles, such that AXL applications will require minor updates every two years.
  • New AXL schemas are added in the first major (N.n.n) and first minor (n.1.n or n.5.n) release of each Unified CM version.
  • Old AXL schemas are deprecated in the first major (N.n.n) and first minor (n.1.n or n.5.n) release of each Unified CM version.
  • Maintenance releases never include new AXL schemas (e.g. n.n.N).
  • Developers should always specify the desired AXL schema version in the SOAPAction Header to ensure the desired schema is applied to the request.
  • Developers who do not specify a desired AXL schema will always connect to the oldest schema available.
  • Use of the executeSQLQuery and executeSQLUpdate interfaces provide no backward compatibility between Unified CM releases. Cisco recommends Developers avoid using these interfaces, as they bypass the schema abstraction layer and interoperate with the database schema directly. Applications which make use of these interfaces may break when the database schema changes. Cisco reserves the right to change the database schema in any release, at any time, for any reason, without any notice.

The following sample AXL request shows how to use the SOAP Action Header to specify the schema version.

The SoapAction header (line 5) specifies that the request uses the 8.5 AXL Schema and the getPhone API resource. Line 9 specifies that the request uses the 8.5 AXL schema namespace. The getPhone element from the specified namespace is used to specify the specific device used in this request.

1 2 3 4
5
6 7 8
9
10 11
12 13 14
15 16
Host:10.77.31.194:8443 Authorization: Basic Q0NNQWRtaW5pc3RyYXRvcjpjaXNjb19jaXNjbw== Accept: text/* Content-type: text/xml
SOAPAction: "CUCM:DB ver=8.5 getPhone"
Content-length: 427 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" <soapenv:Header/> <soapenv:Body>
<ns:getPhone sequence="?"> <name>SEPE8B7480316D6</name> </ns:getPhone>
</soapenv:Body> </soapenv:Envelope>

Next Steps

Checkout...

The Operations by Release matrix

See which AXL APIs are supported in which release.

Read...

what's New and Changed
Read about recent AXL updates

Get...

The Latest AXL Docs
Read the latest version of the AXL Developer reference docs.