com.quantum.dxi.rest.alert

Class ServiceTickets

java.lang.Object

Base

com.quantum.dxi.rest.alert.ServiceTickets

public class ServiceTickets
extends Base

The ServiceTickets resource represents service tickets on the system. The ServiceTickets interface includes services for getting service ticket details, adding notes to service tickets, and closing service tickets. determining if the system has any open service tickets.

The schema that defines the ServiceTickets resource is defined below.

 
    <xs:element name="TicketAnalysisEmailRecipient">
      <xs:complexType>
        <xs:sequence>
            <xs:element name="Address" type="xs:string"/>
            <xs:element name="Comment" type="xs:string" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType>
    </xs:element>

    <xs:element name="Details" type="TicketDetailsType"/>
    <xs:complexType name="TicketDetailsType">
        <xs:sequence>
            <xs:element name="Time" type="xs:string" minOccurs="0"/>
            <xs:element name="Summary" type="xs:string" minOccurs="0"/>
            <xs:element name="Details" type="xs:string" minOccurs="0"/>
            <xs:element name="Recommendation" type="xs:string" minOccurs="0"/>
        </xs:sequence>
    </xs:complexType>

    <xs:element name="ServiceTicket">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Number" type="xs:int">
                    <xs:annotation>
                        <xs:documentation>This is the unique key</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="RequestId" type="xs:int" minOccurs="0"/>
                <xs:element name="AlertState" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="OPEN"/>
                            <xs:enumeration value="CLOSED"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="Priority" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="LOW"/>
                            <xs:enumeration value="MIDDLE"/>
                            <xs:enumeration value="HIGH"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="LastUpdateTimeString" type="xs:string" minOccurs="0"/>
                <xs:element name="LastUpdateTime" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>A null LastUpdateTime indicates a failure to parse the LastUpdateTimeString due to unrecognized format</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Summary" type="xs:string" minOccurs="0"/>
                <xs:element name="OpenedAtString" type="xs:string" minOccurs="0"/>
                <xs:element name="OpenedAt" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>A null OpenedAt time indicates a failure to parse the OpenedAtString due to unrecognized format</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="ClosedAtString" type="xs:string" minOccurs="0"/>
                <xs:element name="ClosedAt" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>A null ClosedAt time indicates a failure to parse the ClosedAtString due to unrecognized format, or string was "Open"</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="ClosedBy" type="xs:string" minOccurs="0"/>
                <xs:element ref="Details" minOccurs="0" maxOccurs="unbounded"/>
                <xs:element name="Notes" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="ServiceTickets">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of service tickets</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="ServiceTicket" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="ServiceTicketColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Number"/>
            <xs:enumeration value="RequestId"/>
            <xs:enumeration value="State"/>
            <xs:enumeration value="Priority"/>
            <xs:enumeration value="LastUpdateTime"/>
            <xs:enumeration value="Summary"/>
            <xs:enumeration value="OpenedAt"/>
            <xs:enumeration value="ClosedAt"/>
            <xs:enumeration value="ClosedBy"/>
            <xs:enumeration value="Notes"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
ServiceTickets()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	closeAllServiceTickets(javax.servlet.http.HttpServletRequest request, java.lang.String errorType) POST /rest/ServiceTickets/closeAll
ServiceTicket	getServiceTicket(javax.servlet.http.HttpServletRequest request, java.lang.Integer number, java.lang.String errorType) GET /rest/ServiceTickets/{number}
com.quantum.dxi.dao.types.ServiceTickets	getServiceTickets(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/ServiceTickets
NumericScalarType	getServiceTicketsCount(javax.servlet.http.HttpServletRequest request, java.lang.String filterString, java.lang.String errorType) GET /rest/ServiceTickets/getRowCount
BooleanScalarType	hasOpenTicket(javax.servlet.http.HttpServletRequest request) GET /rest/ServiceTickets/hasOpenTicket
BooleanScalarType	postAction(javax.servlet.http.HttpServletRequest request, java.lang.String actionString) Deprecated. As of 1.1, ?action=hasOpenTicket replaced by hasOpenTicket(HttpServletRequest)
javax.ws.rs.core.Response	sendServiceTicketAnalysis(javax.servlet.http.HttpServletRequest request, java.lang.Integer number, TicketAnalysisEmailRecipient recipient, java.lang.String errorType) POST /rest/ServiceTickets/sendAnalysis/{number}
javax.ws.rs.core.Response	updateServiceTicket(javax.servlet.http.HttpServletRequest request, java.lang.Integer number, ServiceTicket ticket, java.lang.String errorType) PUT /rest/ServiceTickets/{number}

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceTickets

public ServiceTickets()

Method Detail

getServiceTicketsCount

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

GET /rest/ServiceTickets/getRowCount

Get the number of Service Tickets on the system.

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

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

Since:

1.1

getServiceTickets

public com.quantum.dxi.dao.types.ServiceTickets getServiceTickets(@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/ServiceTickets

Get the Service Tickets on the system. This service returns summary information about service tickets, it does not include detailed information. Summary information includes the following elements of the ServiceTicket element: Number, RequestId, AlertState, Priority, LastUpdateTime, Summary. To retrieve additional details about a Service ServiceTicket, use the GET /rest/ServiceTickets/{number} service.

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

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

Since:

1.1

getServiceTicket

public ServiceTicket getServiceTicket(@Context
                                      javax.servlet.http.HttpServletRequest request,
                                      java.lang.Integer number,
                                      java.lang.String errorType)

GET /rest/ServiceTickets/{number}

Get the complete Service ServiceTicket on the system identified by {number}. This includes the Service ServiceTicket detail information that is not provided by the GET /rest/ServiceTickets service, specifically the OpenedAt, ClosedAt, ClosedBy, Details, Notes elements.

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

Since:

1.1

updateServiceTicket

public javax.ws.rs.core.Response updateServiceTicket(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     java.lang.Integer number,
                                                     ServiceTicket ticket,
                                                     java.lang.String errorType)

PUT /rest/ServiceTickets/{number}

Update the Service ServiceTicket on the system identified by {number}. This method allows you to update a note associated with a ticket, and optionally close the ticket. Only the Number, Notes, and AlertState fields are used, all of the other ServiceTicket fields are read-only. The AlertState field can only be used to close a ticket (i.e., change its state from OPEN to CLOSED); a request to set a ticket's state to OPEN will be ignored.

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

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

Since:

1.1

closeAllServiceTickets

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

POST /rest/ServiceTickets/closeAll

Close all Service Tickets on the system.

Since:

1.1

sendServiceTicketAnalysis

public javax.ws.rs.core.Response sendServiceTicketAnalysis(@Context
                                                           javax.servlet.http.HttpServletRequest request,
                                                           java.lang.Integer number,
                                                           TicketAnalysisEmailRecipient recipient,
                                                           java.lang.String errorType)

POST /rest/ServiceTickets/sendAnalysis/{number}

Email Service ServiceTicket analysis information for the ticket identified by {number}. The request body contains the recipient address and an optional comment.

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

Since:

1.1

hasOpenTicket

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

GET /rest/ServiceTickets/hasOpenTicket

response indicates whether or not the system has any open service tickets.

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

Since:

1.1

postAction

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

Deprecated. As of 1.1, ?action=hasOpenTicket replaced by hasOpenTicket(HttpServletRequest)

POST /rest/ServiceTickets

Perform the requested action on the system's service tickets. The action query parameter is required.

Supported actions are:

• ?action=hasOpenTicket response indicates whether or not the system has any open service tickets

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