com.quantum.dxi.rest.vtl

Class AlertEmailRecipients

java.lang.Object

Base

com.quantum.dxi.rest.vtl.AlertEmailRecipients

public class AlertEmailRecipients
extends Base

The AlertEmailRecipients resource represents configuration of email recipients on the system. The AlertEmailRecipients interface includes services for getting, updating, creating, and deleting email recipients.

The schema that defines the AlertEmailRecipients resource is defined below.

 
    <xs:element name="AlertEmailRecipients">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of alert email recipients</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="AlertEmailRecipient" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="AlertEmailRecipient">
        <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="Address" type="xs:string"/>
                <xs:element name="NotificationType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="HIGH"/>
                            <xs:enumeration value="HIGH_AND_MEDIUM"/>
                            <xs:enumeration value="ALL"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="Enabled" type="xs:boolean"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="AlertEmailRecipientColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Name"/>
            <xs:enumeration value="Address"/>
            <xs:enumeration value="NotificationType"/>
            <xs:enumeration value="Enabled"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
AlertEmailRecipients()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addAlertEmailRecipient(javax.servlet.http.HttpServletRequest request, AlertEmailRecipient alertEmailRecipient, java.lang.String errorType) POST /rest/AlertEmailRecipients
void	deleteAlertEmailRecipient(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) DELETE /rest/AlertEmailRecipients/{name}
AlertEmailRecipient	getAlertEmailRecipient(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) GET /rest/AlertEmailRecipients/{name}
com.quantum.dxi.dao.types.AlertEmailRecipients	getAlertEmailRecipients(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString, java.lang.String errorType) GET /rest/AlertEmailRecipients
NumericScalarType	getAlertEmailRecipientsCount(javax.servlet.http.HttpServletRequest request, java.lang.String filterString, java.lang.String errorType) GET /rest/AlertEmailRecipients/getRowCount
StringListScalarType	getAlertEmailRecipientsNames(javax.servlet.http.HttpServletRequest request, java.lang.String filterString, java.lang.String errorType) GET /rest/AlertEmailRecipients/getNames
javax.ws.rs.core.Response	sendTestEmail(javax.servlet.http.HttpServletRequest request, java.lang.String name) POST /rest/AlertEmailRecipients/test/{name}
AlertEmailRecipient	updateAlertEmailRecipient(javax.servlet.http.HttpServletRequest request, java.lang.String name, AlertEmailRecipient alertEmailRecipient, java.lang.String errorType) PUT /rest/AlertEmailRecipients/{name}

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertEmailRecipients

public AlertEmailRecipients()

Method Detail

getAlertEmailRecipientsCount

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

GET /rest/AlertEmailRecipients/getRowCount

Get the number of AlertEmailRecipients configured on the system.

getAlertEmailRecipientsCount supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="AlertEmailRecipientColumnName">

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

Since:

1.1

getAlertEmailRecipientsNames

public StringListScalarType getAlertEmailRecipientsNames(@Context
                                                         javax.servlet.http.HttpServletRequest request,
                                                         java.lang.String filterString,
                                                         java.lang.String errorType)

GET /rest/AlertEmailRecipients/getNames

Get the names of AlertEmailRecipients configured on the system.

getAlertEmailRecipientsNames supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="AlertEmailRecipientColumnName">

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

Since:

1.1

getAlertEmailRecipients

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

GET /rest/AlertEmailRecipients

Get the AlertEmailRecipients configured on the system.

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

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

Since:

1.1

getAlertEmailRecipient

public AlertEmailRecipient getAlertEmailRecipient(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  java.lang.String name,
                                                  java.lang.String errorType)

GET /rest/AlertEmailRecipients/{name}

Get the AlertEmailRecipient on the system identified by {name}.

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

Since:

1.1

deleteAlertEmailRecipient

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

DELETE /rest/AlertEmailRecipients/{name}

Delete the AlertEmailRecipient on the system identified by {name}.

Since:

1.1

updateAlertEmailRecipient

public AlertEmailRecipient updateAlertEmailRecipient(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     java.lang.String name,
                                                     AlertEmailRecipient alertEmailRecipient,
                                                     java.lang.String errorType)

PUT /rest/AlertEmailRecipients/{name}

Update the AlertEmailRecipient on the system identified by {name}.

Request Entity type: <xs:element name="AlertEmailRecipient">

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

Since:

1.1

addAlertEmailRecipient

public javax.ws.rs.core.Response addAlertEmailRecipient(@Context
                                                        javax.servlet.http.HttpServletRequest request,
                                                        AlertEmailRecipient alertEmailRecipient,
                                                        java.lang.String errorType)

POST /rest/AlertEmailRecipients

Create a new AlertEmailRecipient on the system.

Request Entity type: <xs:element name="AlertEmailRecipient">

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

Since:

1.1

sendTestEmail

public javax.ws.rs.core.Response sendTestEmail(@Context
                                               javax.servlet.http.HttpServletRequest request,
                                               java.lang.String name)

POST /rest/AlertEmailRecipients/test/{name}

Send a test email to an alert recipient. Note that {name} refers to an AlertEmailRecipient's name, not an email address.

Since:

1.1