com.quantum.dxi.rest

Class Version

java.lang.Object

Base

com.quantum.dxi.rest.Version

Deprecated.

Use ApiVersion instead.

public class Version
extends Base

The Version resource represents the version of the system REST Web Services API. The Version interface include a service for getting the version of the API. Clients may want to use this information to build capability-aware user interfaces.

The schema that defines the Version resource is defined below.

 
    <xs:element name="Version">
        <xs:annotation>
            <xs:documentation>http://semver.org/</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Major" type="xs:int">
                    <xs:annotation>
                        <xs:documentation>MUST be incremented if any backwards incompatible changes are introduced to the public API.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Minor" type="xs:int">
                    <xs:annotation>
                        <xs:documentation>MUST be incremented if new, backwards compatible functionality is introduced to the public API.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Patch" type="xs:int">
                    <xs:annotation>
                        <xs:documentation>MUST be incremented if only backwards compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Special" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>A special version number MAY be denoted by appending an arbitrary string immediately following the patch version. The string MUST be comprised of only alphanumerics plus dash [0-9A-Za-z-] and MUST begin with an alpha character [A-Za-z]. Special versions satisfy but have a lower precedence than the associated normal version. Precedence SHOULD be determined by lexicographic ASCII sort order. For instance: 1.0.0beta1 is less than  1.0.0beta2 is less than 1.0.0.</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
Version() Deprecated.

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.Version	getVersion(javax.servlet.http.HttpServletRequest request) Deprecated.
com.quantum.dxi.dao.types.Version	getVersionXml(javax.servlet.http.HttpServletRequest request) Deprecated. As of 1.1, replaced by ApiVersion.getApiVersion(HttpServletRequest)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Version

public Version()

Deprecated.

Method Detail

getVersionXml

public com.quantum.dxi.dao.types.Version getVersionXml(@Context
                                                       javax.servlet.http.HttpServletRequest request)

Deprecated. As of 1.1, replaced by ApiVersion.getApiVersion(HttpServletRequest)

GET /rest/Version

Get the version of the system REST Web Services API on this system. Response Entity type: <xs:element name="Version">

getVersion

public com.quantum.dxi.dao.types.Version getVersion(@Context
                                                    javax.servlet.http.HttpServletRequest request)

Deprecated.