com.quantum.dxi.rest.alert

Class AdminAlerts

java.lang.Object

Base

com.quantum.dxi.rest.alert.AdminAlerts

public class AdminAlerts
extends Base

The AdminAlerts resource represents admin alerts on the system. The AdminAlerts interface includes services for determining if there are any admin alerts on the system.

The schema that defines the AdminAlert resource is defined below.

 
    <xs:element name="AdminAlerts">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of admin alerts</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="AdminAlert" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="AdminAlert">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Name" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>This is the unique key</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Library" type="xs:string"/>
                <xs:element name="LastUpdateTimeString" type="xs:string"/>
                <xs:element name="LastUpdateTime" type="xs:long"/>
                <xs:element name="Summary" type="xs:string"/>
                <xs:element ref="AlertDetails" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="AdminAlertColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Name"/>
            <xs:enumeration value="Library"/>
            <xs:enumeration value="LastUpdateTime"/>
            <xs:enumeration value="Summary"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
AdminAlerts()

Method Summary

Modifier and Type	Method and Description
void	deleteAdminAlert(javax.servlet.http.HttpServletRequest request, String name, String errorType) DELETE /rest/AdminAlerts/{name}
AdminAlert	getAdminAlert(javax.servlet.http.HttpServletRequest request, String name, String errorType) GET /rest/AdminAlerts/{name}
com.quantum.dxi.dao.types.AdminAlerts	getAdminAlerts(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString, String errorType) GET /rest/AdminAlerts
NumericScalarType	getAdminAlertsCount(javax.servlet.http.HttpServletRequest request, String filterString, String errorType) GET /rest/AdminAlerts/getRowCount
BooleanScalarType	hasAdminTicketAlerts(javax.servlet.http.HttpServletRequest request) GET /rest/AdminAlerts/hasAdminTicketAlerts
BooleanScalarType	hasAlert(javax.servlet.http.HttpServletRequest request) GET /rest/AdminAlerts/hasAlert
BooleanScalarType	hasLowCapacityAlert(javax.servlet.http.HttpServletRequest request) GET /rest/AdminAlerts/hasLowCapacityAlert
BooleanScalarType	postAction(javax.servlet.http.HttpServletRequest request, String actionString) Deprecated. As of 1.1 ?action=hasAlert replaced by hasAlert(HttpServletRequest) ?action=hasLowCapacityAlert replaced by hasLowCapacityAlert(HttpServletRequest) ?action=hasAdminTicketAlerts replaced by hasAdminTicketAlerts(HttpServletRequest)

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminAlerts

public AdminAlerts()

Method Detail

getAdminAlertsCount

public NumericScalarType getAdminAlertsCount(@Context
                                             javax.servlet.http.HttpServletRequest request,
                                             String filterString,
                                             String errorType)

GET /rest/AdminAlerts/getRowCount

Get the number of Admin Alerts on the system.

getAdminAlertsCount supports the table query parameters for filtering by column name. Column names are defined in <xs:simpleType name="AdminAlertColumnNameType">

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

Since:

1.1

getAdminAlerts

public com.quantum.dxi.dao.types.AdminAlerts getAdminAlerts(@Context
                                                            javax.servlet.http.HttpServletRequest request,
                                                            int start,
                                                            int limit,
                                                            String sortColumn,
                                                            String sortDirection,
                                                            String filterString,
                                                            String errorType)

GET /rest/AdminAlerts

Get the AdminAlerts on the system. This service returns summary information about admin alerts, it does not include details information. Summary information includes the following elements of the AdminAlert element: Name, Library, LastUpdateTimeString, LastUpdateTime, Summary. To retrieve additional details about an Admin Alert, use the GET /rest/AdminAlerts/{name} service.

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

<xs:element name="AdminAlerts"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:simpleType name="AdminAlertColumnNameType">

Since:

1.1

getAdminAlert

public AdminAlert getAdminAlert(@Context
                                javax.servlet.http.HttpServletRequest request,
                                String name,
                                String errorType)

GET /rest/AdminAlerts/{name}

Get the details for the Admin Alert on the system identified by {name}. This includes all of the information provided by the GET /rest/AdminAlerts service, as well as the information in the AlertDetails element.

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

Since:

1.1

deleteAdminAlert

public void deleteAdminAlert(@Context
                             javax.servlet.http.HttpServletRequest request,
                             String name,
                             String errorType)

DELETE /rest/AdminAlerts/{name}

Delete the Admin Alert on the system identified by {name}.

Since:

1.1

hasAlert

public BooleanScalarType hasAlert(@Context
                                  javax.servlet.http.HttpServletRequest request)

GET /rest/AdminAlerts/hasAlert

response indicates whether or not the system has any admin alerts.

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

Since:

1.1

hasLowCapacityAlert

public BooleanScalarType hasLowCapacityAlert(@Context
                                             javax.servlet.http.HttpServletRequest request)

GET /rest/AdminAlerts/hasLowCapacityAlert

response indicates whether or not the system has any admin alerts related to low capacity.

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

Since:

1.1

hasAdminTicketAlerts

public BooleanScalarType hasAdminTicketAlerts(@Context
                                              javax.servlet.http.HttpServletRequest request)

GET /rest/AdminAlerts/hasAdminTicketAlerts

response indicates whether or not the system has any admin alerts related to admin tickets.

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

Since:

1.1

postAction

public BooleanScalarType postAction(@Context
                                    javax.servlet.http.HttpServletRequest request,
                                    String actionString)

Deprecated. As of 1.1
?action=hasAlert replaced by hasAlert(HttpServletRequest)
?action=hasLowCapacityAlert replaced by hasLowCapacityAlert(HttpServletRequest)
?action=hasAdminTicketAlerts replaced by hasAdminTicketAlerts(HttpServletRequest)

POST /rest/AdminAlerts

Perform the requested action on the system's admin alerts. The action query parameter is required.

Note to dev team: are these optimized in some way? Seems that these queries could just be performed as GETs with a filter on some alert fields. We should look into this in the future for API consistency.

Supported actions are:

• ?action=hasAlert response indicates whether or not the system has any admin alerts
• ?action=hasLowCapacityAlert response indicates whether or not the system has any admin alerts related to low capacity
• ?action=hasAdminTicketAlerts response indicates whether or not the system has admin alerts related to admin tickets

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