com.quantum.dxi.rest

Class ApiVersion

java.lang.Object

Base

com.quantum.dxi.rest.ApiVersion

public class ApiVersion
extends Base

The ApiVersion resource represents the version of the system REST Web Services API. The ApiVersion 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 ApiVersion resource is defined below.

 
    <xs:element name="ApiVersion">
        <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:sequence>
        </xs:complexType>
    </xs:element>
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	API_MAJOR_VERSION
static int	API_MINOR_VERSION

Constructor Summary

Constructors

Constructor and Description
ApiVersion()

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.ApiVersion	getApiVersion(javax.servlet.http.HttpServletRequest request) GET /rest/ApiVersion

Methods inherited from class java.lang.Object

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

Field Detail

API_MAJOR_VERSION

public static final int API_MAJOR_VERSION

See Also:

Constant Field Values

API_MINOR_VERSION

public static final int API_MINOR_VERSION

See Also:

Constant Field Values

Constructor Detail

ApiVersion

public ApiVersion()

Method Detail

getApiVersion

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

GET /rest/ApiVersion

Get the version of the system REST Web Services API on this system.

Note: this service does not, and must never, require authentication. Clients need to be able to call this before they are authenticated, so they know what version of the authentication interface(s) is/are supported.

Response Entity type: <xs:element name="ApiVersion">

Since:

1.1