SavvisStation Customer Portal Web Service Guide [PortalData Service]

Terms of Use

By using this API and accessing the information provided herein, you understand and agree to the following terms.  All information is provided AS IS in good faith as to its accuracy when presented, but is for informational purposes only.  Savvis shall have no liability to any party for the API or the information provided therein.  You will not use or rely upon the information for any critical business function or allow any third parties to do so.  All information is subject to actual Savvis validation based on its records and systems for any purpose related to service level agreements.  Savvis has no obligation to update, patch or otherwise support this API or related functionality, and you may not seek such support through any Savvis customer support organizations, including the Help Desk.  Savvis makes no commitments and shall have no responsibility for the availability or performance of this API.  This API is subject to change without notice in Savvis' sole discretion.


Download this document



Interface PortalData


WSDL Location
WSDL for service PortalData is located at [SSPortalURL]/services/PortalData?wsdl (www.savvisstation.savvis.com/services/PortalData?wsdl)

Authentication
Calls are made within the scope of the logged in user, and without valid SavvisStation credentials, no data retrieval calls can be made.
To supply a username and password to the PortalData service, set the username and password via a SOAP Header formatted as:

<authenticate>
    <username xsi:type="xsd:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">usernameString</username>
    <password xsi:type="xsd:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">passwordString</password>

    <companyName xsi:type="xsd:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">companyNameString</
companyName>
</authenticate>

These credentials must persist throughout the use of the client's calls.

Note1: The companyName element is optional, and is to be used for logins with multiple customer access. The value of this element is the full name of the desired company; the name must persist in the header until another company is needed for lookup, in which case the backend will destroy the initial company's user profile and a new one will be made, and so on.

Note2 [as of 8/2011]: Specific access needs to be granted to the username taking advantage of the SavvisStation Portal API (excluding administrators). Please contact your Savvis representative to obtain access.

Persistence
To ensure persistence, in Apache Axis Client; setMaintainSession must be called on the binding so that credentials/data can be stored for the user on the server side.
Any other SOAP clients must accept the session cookie that is sent by the server, and send it back in all requests.

    From server example: Set-Cookie: JSESSIONID=3B9260EFA3C886D563C9D906E341085C; Path=/ccc

    From client (expected in requests) example: Cookie: JSESSIONID=3B9260EFA3C886D563C9D906E341085C

SSL is used throughout the SavvisStation Customer Portal, and the PortalData service works within the SSL tunnel.  A www.savvisstation.savvis.com public certificate should be installed to complete the handshake.  It is in a Java Keystore format.

Client side timeouts are recommended to be at least 120000 millis [for large data retrieval such as get many tickets, etc.].

Finally, bindings (stubs) that represent a means of retrieving data are not thread safe.  Attempt to multithread a stub will result in multiple instances of corresponding classes being created in the backend and will break the persistence model.

Examples
Several examples/snippets are offered to help start a client application's development:


Field Summary
String EVENT_PROPERTY_ALERT_GROUP
          Used for limiting event(s) search:           Limit search for an event based on an alert group (array of values permissible)
String EVENT_PROPERTY_ALERT_KEY
           Used for limiting event(s) search:          Limit search for an event based on an alert key (array of values permissible)
String EVENT_PROPERTY_DATE_RELATIVE
           Used for limiting event(s) search:          Specify a relative date range by indicating how many days in the past to search (up to 30 days)
String EVENT_PROPERTY_END_DATE
           Used for limiting event(s) search:          Set event end date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-07-05 07:00)
String EVENT_PROPERTY_NODE
           Used for limiting event(s) search:          Limit search for an event based on a name of a node(s) (array of values permissible)
String EVENT_PROPERTY_SERIAL
           Used for limiting event(s) search:          Return events for supplied serial(s) only (array of values permissible)
String EVENT_PROPERTY_SEVERITY
           Used for limiting event(s) search:          Limit search for events with a specific severity
String EVENT_PROPERTY_SITE
           Used for limiting event(s) search:          Limit search for an event for a specific site(s) (array of values permissible)
String EVENT_PROPERTY_START_DATE
           Used for limiting event(s) search:          Set event start date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00)
String PROPERTY_FETCH_SIZE
           Describes global properties (info only):          Key to an integer representing the max number of items returned in a single mass-data request (ex: getTickets)
String PROPERTY_EVENT_DAYS_MAX
          Describes global properties (info only):         Key to represent the max number of day range between time periods on which events occurred
String PROPERTY_TICKET_DAYS_MAX
           Describes global properties (info only):          Key to represent the max number of day range between time periods on which tickets were created
String PROPERTY_FUTURE_CHANGES_WEEKS_MAX
           Describes global properties (info only):         Key to represent the max number of week range (allowed for retrieval) between time periods on which future changes/maintenance is planned
String TICKET_PROPERTY_END_DATE
          Used for limiting ticket(s) search:          Set ticket end date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-07-05 07:00)
String TICKET_PROPERTY_NOTES
          Used for limiting ticket(s) search:          Flag for requesting the Note[] element of the TroubleTicket be populated (may result in much longer response times)
String TICKET_PROPERTY_OPEN
          Used for limiting ticket(s) search:          Flag for requesting only tickets in the Open state
String TICKET_PROPERTY_START_DATE
          Used for limiting ticket(s) search:          Set ticket start date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00)
String TICKET_PROPERTY_XREF
          Used for limiting ticket(s) search:          Filter the ticket search for ONLY tickets with the parametered Customer X Reference value
String TICKET_PROPERTY_MULTICUSTOMER_SEARCH
          Used for limiting ticket(s) search:          Request that ALL tickets across ALL permissible companies be searched against (applicable to customers with > 1 company assigned to their login)
String FUTURE_CHANGE_PROPERTY_CUSTOMER_IMPACTING
           Used for limiting maintenance activity search:          Specifies whether to return customer impacting changes only for future maintenance activities
String FUTURE_CHANGE_PROPERTY_WEEKS
           Used for limiting maintenance activity search:          Sets the number of weeks of future maintenance objects to return
String FUTURE_CHANGE_PROPERTY_START_DATE
           Used for limiting maintenance activity search:          Sets the start date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00)
String FUTURE_CHANGE_PROPERTY_END_DATE
           Used for limiting maintenance activity search:          Sets the end date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00)
 
Method Summary
void addNoteToTicket(PortalObject ticketNoteObject)
          Creates a single ticket note (using attributes in the parametered PortalObject) and adds it to the ticket whose unique ID is specified in the ticketNoteObject.
int createTicket(PortalObject ticketObject)
          Creates a single ticket using attributes that are included in the parametered ticketObject.
void updateTicket(PortalObject ticketObject)
          Updates a single ticket using attributes that are included in the parametered ticketObject.
 PortalObject[] getEventJournals(int serial)
          List all journal entries for a particular event.
 PortalObject[] getEventJournals(PortalMapItem[] custRestricts)
          List all journal entries while applying a map of restrictions.
 PortalObject[] getEvents(PortalMapItem[] custRestricts)
          Searches for and returns events using parametered restrictions.
 PortalObject[] getMoreEventJournals()
          Returns the next batch of JOURNAL items (as an array) if the last request was larger than PROPERTY_FETCH_SIZE.
 PortalObject[] getMoreEvents()
          Returns the next batch of EVENT items (as an array) if the last request was larger than PROPERTY_FETCH_SIZE.
PortalObject[] getMoreFutureChanges()
          Returns the next batch of PortalObject (ActivityDetail) items (as an array) if the last request for future changes was larger than PROPERTY_FETCH_SIZE.
 PortalObject[] getMoreTickets()
          Returns the next batch of TroubleTicket items (as an array) if the last tickets request was larger than PROPERTY_FETCH_SIZE.
PortalObject[] getFutureChanges(PortalMapItem[] options)
          Returns an array of PortalObject data types representing future/maintenance changes scheduled for the user parametered time frame.
 PortalMapItem[] getProperties()
          Returns all default and user defined properties (as described by public members PROPERTY_*).
PortalMapItem[] getTicketSubjects()
          When creating a ticket, a user must supply one of a list of pre-defined subject lines.
 PortalObject getTicketFieldsByID(int ticketId)
          Returns a Trouble Ticket for a supplied ticket ID.
 PortalObject[] getTicketJournalByID(int ticketId)
          Returns an array of Note objects associated with the ticket found for the supplied ID.
 PortalObject[] getTickets(PortalMapItem[] restrictions)
          Returns an array of TroubleTickets containing all tickets associated with the currently logged in customer.
PortalMapItem[] getObjectAliasMap()
          Returns a map of object aliases keyed off their respective ID/types.
 void logout()
          Resets the server side Web Service session and clears the SSPortal DB session corresponding to this set of calls.
 

Field Detail

PROPERTY_FETCH_SIZE

static final String PROPERTY_FETCH_SIZE
Key to a predetermined integer representing the maximum number of items returned in a single mass-data request (ex: getTickets). This also applies for getMore() calls.

 

See Also:
Constant Field Values

PROPERTY_EVENTS_DAYS_MAX

static final String PROPERTY_FETCH_SIZE
Key to represent the maximum numbers of day range between time periods on which events occurred

 

See Also:
Constant Field Values

PROPERTY_TICKETS_DAYS_MAX

static final String PROPERTY_FETCH_SIZE
Key to represent the maximum numbers of day range between time periods on which tickets were created

 

See Also:
Constant Field Values
 

PROPERTY_FUTURE_CHANGES_WEEKS_MAX

static final String PROPERTY_FUTURE_CHANGES_WEEKS_MAX
Key to represent the maximum number of week range (allowed for retrieval) between time periods on which future changes/maintenance is planned

 

See Also:
Constant Field Values
 

TICKET_PROPERTY_OPEN

static final String TICKET_PROPERTY_OPEN
Flag for requesting only tickets in the Open state String

 

See Also:
Constant Field Values

TICKET_PROPERTY_NOTES

static final String TICKET_PROPERTY_NOTES
Flag for requesting the Note[] element of the TroubleTicket be populated (Requesting notes may make the call take longer as large amounts of text may need to be sent.) Boolean

 

See Also:
Constant Field Values

TICKET_PROPERTY_START_DATE

static final String TICKET_PROPERTY_START_DATE
Set ticket start date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00) String

 

See Also:
Constant Field Values

TICKET_PROPERTY_XREF

static final String TICKET_PROPERTY_XREF
Filter the ticket search for ONLY tickets with the parametered Customer X Reference value String

 

See Also:
Constant Field Values

TICKET_PROPERTY_MULTICUSTOMER_SEARCH

static final String TICKET_PROPERTY_MULTICUSTOMER_SEARCH
Request that ALL tickets across ALL permissible companies be searched against (applicable to customers with > 1 company assigned to their login) Boolean

 

See Also:
Constant Field Values

TICKET_PROPERTY_END_DATE

static final String TICKET_PROPERTY_END_DATE
Set ticket end date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-07-05 07:00) String

 

See Also:
Constant Field Values

FUTURE_CHANGE_PROPERTY_WEEKS

static final String FUTURE_CHANGE_PROPERTY_WEEKS
Sets the number of weeks of future maintenance objects to return

 

See Also:
Constant Field Values

FUTURE_CHANGE_PROPERTY_CUSTOMER_IMPACTING

static final String FUTURE_CHANGE_PROPERTY_CUSTOMER_IMPACTING
Specifies whether to return customer impacting changes only for future maintenance activities

 

See Also:
Constant Field Values

FUTURE_CHANGE_PROPERTY_START_DATE

static final java.lang.String FUTURE_CHANGE_PROPERTY_START_DATE
Sets the start date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00) java.lang.String

 

See Also:
Constant Field Values

FUTURE_CHANGE_PROPERTY_END_DATE

static final java.lang.String FUTURE_CHANGE_PROPERTY_END_DATE
Sets the end date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00) java.lang.String

 

See Also:
Constant Field Values

EVENT_PROPERTY_SERIAL

static final String EVENT_PROPERTY_SERIAL
Return events for supplied serial(s) only (array of values permissible) String or String[]

 

See Also:
Constant Field Values

EVENT_PROPERTY_SEVERITY

static final String EVENT_PROPERTY_SEVERITY
Limit search for events with a specific severity. Valid values are: "NORMAL", "UNKNOWN", "WARNING", "MINOR", "MAJOR", "CRITICAL" (array of values permissible) String or String[]

 

See Also:
Constant Field Values

EVENT_PROPERTY_NODE

static final String EVENT_PROPERTY_NODE
Limit search for an event based on a name of a node(s) (array of values permissible) String or String[]

 

See Also:
Constant Field Values

EVENT_PROPERTY_SITE

static final String EVENT_PROPERTY_SITE
Limit search for an event for a specific site(s) (array of values permissible) String or String[]

 

See Also:
Constant Field Values

EVENT_PROPERTY_ALERT_GROUP

static final String EVENT_PROPERTY_ALERT_GROUP
Limit search for an event based on an alert group (array of values permissible) String or String[]

 

See Also:
Constant Field Values

EVENT_PROPERTY_ALERT_KEY

static final String EVENT_PROPERTY_ALERT_KEY
Limit search for an event based on an alert key (array of values permissible) String or String[]

 

See Also:
Constant Field Values

EVENT_PROPERTY_START_DATE

static final String EVENT_PROPERTY_START_DATE
Set event start date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00) String

 

See Also:
Constant Field Values

EVENT_PROPERTY_END_DATE

static final String EVENT_PROPERTY_END_DATE
Set event end date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-07-05 07:00) String

 

See Also:
Constant Field Values

EVENT_PROPERTY_DATE_RELATIVE

static final String EVENT_PROPERTY_DATE_RELATIVE
Specify a relative date range by indicating how many days in the past to search (up to 30 days) String

 

See Also:
Constant Field Values
Method Detail

logout

void logout()
Resets the server side Web Service session and clears the SSPortal DB session corresponding to this set of calls.

To destroy the client side session completely, the stub must be set to null, or username/password be reset; as long as a valid username/password remain in the client stub, a new session will be created automatically.

 


getProperties

PortalMapItem[] getProperties()
Returns all default and user defined properties (as described by public members PROPERTY_*).

 

Returns:
PortalMapItem[] containing key value pairs of properties associated with this service instance

getObjectAliasMap

PortalMapItem[] getObjectAliasMap()
Returns a map of object aliases keyed off their respective ID/types. The naming details are stored in a PortalObject type consisting of short name, long name, etc.

Refer to OBJECT_ALIAS_PROPERTY_* for a complete description of attributes supplied by the aforementioned PortalObject types

 

Returns:
PortalMapItem[] containing key value pairs of service object type & id values to a series of naming details.

getTicketSubjects

PortalMapItem[] getTicketSubjects()
When creating a ticket, a user must supply one of a list of pre-defined subject lines. This method returns a map of all available ticket subjects across {current} ticket types: Network Incident/Problem, Network Request, Hosting Incident/Problem, Hosting Request.

The values are keyed off unique Strings such as: support.case.create.network.request.r201, support.case.create.hosting.problem.p242, etc.

 

Returns:
PortalMapItem[] containing key value pairs of allowed Case/Ticket subjects (for use in ticket creation)

getTicketFieldsByID

PortalObject getTicketFieldsByID(int ticketId)
Returns a Trouble Ticket for a supplied ticket ID. The object has all information populated as if it were shown in the Portal. An array of Note[] contains a series of notes associated with this ticket in original [sometimes HTML style] formatted state.

            For instructions on viewing TICKET_ATTR_NOTES attribute of a ticket , please refer to documentationon

Parameters:
ticketId - Unique ID of the ticket to be retrieved
Returns:
TroubleTicket object containing all fields of a Trouble Ticket (including an array of Notes)

getTicketJournalByID

PortalObject[] getTicketJournalByID(int ticketId)
Returns a size: 1 array of a map of Note objects associated with the ticket found for the supplied ID.

The structure of the map of NoteDate -> Note is as follows:

PortalObject [0]
  	+--[name: 'Note map']
  	+--[attributes: PortalMapItem[] <DateOfNote, PortalObject[name: 'Note']>
[for each PortalMapItem entry:]	   PortalObject
		        	+--[name: 'Note']
			       	+--[attributes: Attributes of a single Note keyed by TICKET_NOTE_ATTR_* constants]		        	
		        	

 

Parameters:
ticketId - Unique ID of the ticket to retrieve notes for
Returns:
Array containing a single 'Note Map' PortalObject containing mappings of note date -> fields of a Note portion of a Trouble Ticket.  If there are no notes for this ticket, the single PortalObject[0] element will be null.

getTickets

PortalObject[] getTickets(PortalMapItem[] restrictions)
Returns an array of TroubleTickets containing all tickets associated with the currently logged in customer. This method will return up to the first n (where n = PROPERTY_FETCH_SIZE) TroubleTicket objects. If n tickets are returned, getMoreTickets should be called repeatedly to get the rest of the result set.
            For instructions on viewing TICKET_ATTR_NOTES attribute of a ticket, please refer to documentationon

Parameters:
restrictions - PortalMapItem[] containing restrictions to limit the ticket search as well as other miscellaneous options.

The permitted key-value pairs are described as:
[KEY_NAME_STRING {Value type} Description of parameter]

Examples:
TICKET_PROPERTY_OPEN {Boolean} Flag for requesting only tickets in the Open state
TICKET_PROPERTY_NOTES {Boolean} Flag for requesting the Note[] element of the TroubleTicket be populated (Requesting notes may make the call take longer as large amounts of text may need to be sent.)
TICKET_PROPERTY_TIMEZONE {String} Set a timezone to get ticket open/close dates in; default is "CST6CDT"
TICKET_PROPERTY_START_DATE {String} Set ticket start date cutoff in format YYYY-MM-DD hh:mm (ex: 2008-06-28 07:00)  
TICKET_PROPERTY_XREF {String} Filter the ticket search for ONLY tickets with the parametered Customer X Reference value (ex: -9999)
TICKET_PROPERTY_MULTICUSTOMER_SEARCH {Boolean} Request that ALL tickets across ALL permissible companies be searched against (applicable to customers with > 1 company assigned to their login)
TICKET_PROPERTY_END_DATE {String} Set ticket end date cutoff in format YYYY-MM-DD hh:mm (ex: 2008-07-05 07:00)
Returns:
Array of TroubleTicket objects containing all fields of a Trouble Ticket (with or without Notes {Note[]})

getMoreTickets

PortalObject[] getMoreTickets()
Returns the next batch of TroubleTicket items (as an array) if the last tickets request was larger than PROPERTY_FETCH_SIZE. This method should be called continuously until an empty array is returned, indicating no more results.

 

Returns:
Array of TroubleTicket objects containing all fields of a Trouble Ticket (with or without Notes {Note[]})

createTicket

int createTicket(PortalObject ticketObject)
Creates a single ticket using attributes that are included in the parametered ticketObject.

Valid subject strings can be retrieved via the getTicketSubjects method for categories: Network Incident/Problem, Network Request, Hosting Incident/Problem, Hosting Request

The fields for tickets that are settable include:

            TICKET_ATTR_LOGICAL_SITE_ID - string :: (ie. S22133)
            TICKET_ATTR_REPORTED_BY - string :: representation of person/entity reporting the ticket
            TICKET_ATTR_PRIORITY - string :: must be one of '1 - Urgent', '2 - High', '3 - Medium', or '4 - Low'
            TICKET_ATTR_SUBJECT - string :: subject of the new ticket
            TICKET_ATTR_TYPE - string :: must be one of: 'Hosting Request', 'Hosting Incident', 'Network Incident', or 'Network Request'
            TICKET_ATTR_CUSTOMER_XREF - string :: foreign identifier into another ticket system for synchronization purposes

                  

                                Example of creation of a ticket in java:

                         PortalObject ticket = new PortalObject();
                PortalMapItem[][] map = new PortalMapItem[][4];
                map[0] = new PortalMapItem[]();  //
equally effective: new PortalMapItem[]("TICKET_ATTR_TYPE", "Network Request");
                map[0].setKey("TICKET_ATTR_TYPE");
                map[0].setValue("Network Request");

                map[1] = new PortalMapItem[]();
                map[1].setKey("TICKET_ATTR_SUBJECT");
                map[1].setValue("there's a test subject here... IGNORE PLEASE - Cog write");

                map[2] = new PortalMapItem[]();
                map[2].setKey("TICKET_ATTR_PRIORITY");
                map[2].setValue("3 - Medium");

                map[3] = new PortalMapItem[]();
                map[3].setKey("TICKET_ATTR_LOGICAL_SITE_ID");
                map[3].setValue("S262804");
                ticket.setAttributes(map);
                ticket.setObjectName("TroubleTicket");

                //equally effective: ticket = new PortalObject("TroubleTicket", map)

                int ticId = binding.createTicket(ticket);
 

 

Parameters:
ticketObject - PortalObject instance with the aforementioned fields set
Returns:
int specifying the unique identifier of the newly created ticket

updateTicket

void updateTicket(PortalObject ticketObject)
Updates a single ticket using attributes that are included in the parametered ticketObject.  This method may be used to upload an attachment (20 MB maximum size) to the ticket (attachment(s) will be available in individual SOAP getTicketFieldsById calls and via the SavvisStation Portal).

Valid subject strings can be retrieved via the getTicketSubjects method for categories: Network Incident/Problem, Network Request, Hosting Incident/Problem, Hosting Request

The fields for tickets that are settable include:

            TICKET_ATTR_PRIORITY - string :: must be one of '1 - Urgent', '2 - High', '3 - Medium', or '4 - Low'
            TICKET_ATTR_SUBJECT - string :: subject of the new ticket
            TICKET_ATTR_CUSTOMER_XREF - string :: foreign identifier into another ticket system for synchronization purposes
            TICKET_ATTR_STATUS - string :: new status of this ticket - currently supported values include: "Closed - Resolved"
            TICKET_ATTR_REASON_CLOSE- string :: If the ticket is being closed a reason must be supplied - an invocation of this method w/ any invalid input will return a formatted error w/ all up to date valid reasons
            TICKET_ATTR_ATTACHMENT_NAME- string :: Full filename with extension (ie. uploaded_doc.txt) attached (via SOAP Attachment Part) to this ticket update request.  This file will be attached to the ticket in question along with a note indicating as such.

                  

                                See createTicket for an example of populating the parameter object and calling this method with it.

                     

Parameters:
ticketObject - PortalObject instance with the aforementioned fields set

addNoteToTicket

void addNoteToTicket(PortalObject ticketNoteObject)
Creates a single ticket note (using attributes in the parametered PortalObject) and adds it to the ticket whose unique ID is specified in the ticketNoteObject.

The fields for tickets that are settable include:

TICKET_NOTE_ATTR_DETAIL_HTML - string :: HTML containing the detail/body of the note
TICKET_NOTE_ATTR_DETAIL - string :: plain text detail/body of the note (referenced only if the TICKET_NOTE_ATTR_DETAIL_HTML  field is empty)
TICKET_NOTE_ATTR_SUBJECT - string :: subject of the new note
TICKET_ATTR_ID - integer :: Case id to reference and to attach this note to
 

              Example of creation of a ticket in java:

                  PortalObject note = new PortalObject();
                PortalMapItem[][] mapN = new PortalMapItem[][4];
                mapN[0] = new PortalMapItem[](); //equally effective: mapN[0] = new PortalMapItem[]("TICKET_NOTE_ATTR_DETAIL", "Non-html")
                mapN[0].setKey("TICKET_NOTE_ATTR_DETAIL");
                mapN[0].
setValue("Non-html");

                mapN[1] = new PortalMapItem[]();
                mapN[1].setKey("TICKET_NOTE_ATTR_DETAIL_HTML");
                mapN[1].
setValue("<b>First</b> message to <i>start</i><br>...things off...2");

                mapN[2] = new PortalMapItem[]();
                mapN[2].setKey("TICKET_NOTE_ATTR_SUBJECT");
                mapN[2].
setValue("This is the original note ... ");

                mapN[3] = new PortalMapItem[]();
                mapN[3].setKey("TICKET_ATTR_ID");
                mapN[3].
setValue(ticId); //valid ticket ID derived previously

                note.setAttributes(mapN);
                note.setObjectName("Note");

                //equally effective: note = new PortalObject("Note", mapN);
           
                binding.addNoteToTicket(note);
 

 

Parameters:
ticketNoteObject - PortalObject instance with the aforementioned fields set

getFutureChanges

PortalObject[] getFutureChanges(PortalMapItem[] options)
Returns an array of PortalObject data types representing future/maintenance changes scheduled for the user parametered time frame.

Refer to FUTURE_CHANGE_PROPERTY_* attributes as options to pass to this method:

 

Parameters:
options - PortalMapItem[] with the restrictions for future maintenance activity retrieval, described as:
[KEY_NAME_STRING {Value type} Description of parameter]

FUTURE_CHANGE_PROPERTY_WEEKS {Integer} Number of weeks into the future to retrieve future maintenance activities for
FUTURE_CHANGE_PROPERTY_CUSTOMER_IMPACTING {Boolean} Flag for requesting only customer impacting changes only or not
FUTURE_CHANGE_PROPERTY_START_DATE {String} Sets the start date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00)


FUTURE_CHANGE_PROPERTY_END_DATE {String} Sets the end date cutoff in format YYYY-MM-DD hh:mm(ex: 2008-06-28 07:00)
 

getMoreFutureChanges

PortalObject[] getMoreFutureChanges()
Returns the next batch of PortalObject (ActivityDetail) items (as an array) if the last request for future changes was larger than PROPERTY_FETCH_SIZE. This method should be called continuously until an empty array is returned, indicating no more results.

 

Returns:
Array of ActivityDetail objects containing all fields of a Future Change/Maintenance object

getEventJournals

PortalObject[] getEventJournals(int serial)
List all journal entries for a particular event. This method will return up to the first n (where n = PROPERTY_FETCH_SIZE) EventJournal objects. If n events are returned, getMoreEventJournals should be called repeatedly to get the rest of the result set.

 

Parameters:
serial - - the serial number of an event
Returns:
an array of journal entries for that event

getEventJournals

PortalObject[] getEventJournals(PortalMapItem[] custRestricts)
List all journal entries while applying a map of restrictions. This method will return up to the first n (where n = PROPERTY_FETCH_SIZE) EventJournal objects. If n events are returned, getMoreEventJournals should be called repeatedly to get the rest of the result set.

 

Parameters:
custRestricts - - PortalMapItem[] with the restrictions for journal retrieval , described as:
 

[KEY_NAME_STRING {Value type} Description of parameter]

EVENT_PROPERTY_SERIAL {String or String[]} Return event journals for supplied serial(s) only (Required)


 
Returns:
an array of journal entries that matched user selection.

getEvents

PortalObject[] getEvents(PortalMapItem[] custRestricts)
Searches for and returns events using parametered restrictions. This method will return up to the first n (where n = PROPERTY_FETCH_SIZE) Event objects. If n events are returned, getMoreEvents should be called repeatedly to get the rest of the result set. If no restrictions are supplied, event retrieval is limited to:
-The last 7 days
-All customer sites
-Condition in "active", "closed", "ticketclosed"

 

Parameters:
custRestricts - PortalMapItem[] with the restrictions for event retrieval, described as:
[KEY_NAME_STRING {Value type} Description of parameter]

Examples:
EVENT_PROPERTY_SERIAL {String or String[]} Return events for supplied serial(s) only
EVENT_PROPERTY_SEVERITY {String or String[]} Limit search for events with a specific severity. Valid values are: "0", "1", "2", "3", "4", "5" corresponding to (NORMAL, UNKNOWN, WARNING, MINOR, MAJOR, CRITICAL)
EVENT_PROPERTY_NODE {String or String[]} Limit search for an event based on a name of a node(s)
EVENT_PROPERTY_SITE {String or String[]} Limit search for an event for a specific site(s)
EVENT_PROPERTY_ALERT_GROUP {String or String[]} Limit search for an event based on an alert group
EVENT_PROPERTY_ALERT_KEY {String or String[]} Limit search for an event based on an alert key
EVENT_PROPERTY_DATE_ABSOLUTE {String} Specify a date range by indicating two specific date-times; first string is the start date, second is the end date. If only one is supplied, it becomes the start date (end date is current time). Furthermore, if both date restricts (EVENT_PROPERTY_DATE_ABSOLUTE and EVENT_PROPERTY_DATE_RELATIVE) are passed, EVENT_PROPERTY_DATE_ABSOLUTE takes precedence. Format is: YYYY-MM-DD hh:mm(ex: 2008-07-05 07:00).
EVENT_PROPERTY_DATE_RELATIVE {String} Specify a relative date range by indicating how many days in the past to search (up to 30 days).

When noted, event restrictions can be supplied as an array of values (ex: EVENT_PROPERTY_SITE={"S112222", "S333212", "S799212"})

Returns:
an array of events that matched user selection.

getMoreEvents

PortalObject[] getMoreEvents()
Returns the next batch of EVENT items (as an array) if the last request was larger than PROPERTY_FETCH_SIZE. This method should be called continuously until an empty array is returned, indicating no more results.

 

Returns:
Array of PortalObject containing all Event fields

getMoreEventJournals

PortalObject[] getMoreEventJournals()
Returns the next batch of JOURNAL items (as an array) if the last request was larger than PROPERTY_FETCH_SIZE. This method should be called continuously until an empty array is returned, indicating no more results.

 

Returns:
Array of PortalObject containing all Journal fields

 

Class PortalMapItem


This class represents a single entry in a simulated map or a PortalMapItem[] array.  For the sake of enhanced interoperability, the PortalData API will use PortalMapItem[] instead of a Map to store key-value pairs.

For example; a 'map' of entries could be represented the following way:

        PortalMapItem[] map = new PortalMapItem[2];
                map[0] = new PortalMapItem();
                map[0].setKey("TICKET_ATTR_TYPE");
                map[0].setValue("Network Request");
                //or equally: map[0] = new PortalMapItem("TICKET_ATTR_TYPE", "Network Request");


                map[1] = new PortalMapItem();
                map[1].setKey("TICKET_ATTR_SUBJECT");
                map[1].setValue("there's a test subject here... IGNORE PLEASE - Cog write");
                ...

 

Constructor Summary
PortalMapItem()
           
PortalMapItem(Object key, Object value)
           
 
Method Summary
 Object getKey()
          Gets the key value for this PortalMapItem.
 Object getValue()
          Gets the value value for this PortalMapItem.
 void setKey(Object key)
          Sets the key value for this PortalMapItem.
 void setValue(Object value)
          Sets the value value for this PortalMapItem.
 

Constructor Detail

PortalMapItem

public PortalMapItem()

PortalMapItem

public PortalMapItem(Object key, Object value)
 
Method Detail

getKey

public Object getKey()
Gets the key value for this PortalMapItem.

 

Returns:
key

setKey

public void setKey(Object key)
Sets the key value for this PortalMapItem.

 

Parameters:
key

getValue

public Object getValue()
Gets the value value for this PortalMapItem.

 

Returns:
value

setValue

public void setValue(Object value)
Sets the value value for this PortalMapItem.

 

Parameters:
value

 

Class PortalObject


PortalObject represents a single instance of a given PortalData object representation.  This class only holds the name of the type and a map of attributes which represent the fields of the particular object type.  The exact types and names of the aforementioned attributes are described in WebServiceConstants


Constructor Summary
PortalObject()
          Constructor creating a new PortalObject with an empty attribute map and no object name
PortalObject(String name)
          Constructor creating a new PortalObject with an empty attribute map and object name of name
 
Method Summary
 PortalMapItem[] getAttributes()
          Returns the entire attribute PortalMapItem[] containing the full list of key-value pairs representing all attributes describing this PortalObject
 String getObjectName()
          Returns the name of this PortalObject's type
 void setAttributes(PortalMapItem[] map)
          Reset the entire attribute map to a new map
 void setObjectName(String name)
          Sets the object name of this PortalObject to a valid PortalData web service object name
 

Constructor Detail

PortalObject

public PortalObject()
Constructor creating a new PortalObject with an empty attribute map and no object name

 


PortalObject

public PortalObject(String name)
Constructor creating a new PortalObject with an empty attribute map and object name of name

 

Parameters:
name - String representing a valid PortalData web service object
Method Detail

setObjectName

public void setObjectName(String name)
Sets the object name of this PortalObject to a valid PortalData web service object name

 

Parameters:
name - String representing a valid PortalData web service object

getObjectName

public String getObjectName()
Returns the name of this PortalObject's type

 

Returns:
String representing this objects' typename

setAttributes

public void setAttributes(PortalMapItem[] map)
Reset the entire attribute map to a new map

 

Parameters:
PortalMapItem[]

getAttributes

public PortalMapItem[] getAttributes()
Returns the entire attribute PortalMapItem[] containing the full list of key-value pairs representing all attributes describing this PortalObject

 

Returns:
PortalMapItem[] instance containing String keys and various Object values. Refer to documentation for specifications.


Class WebServiceConstants


This class describes the attributes of object types supported by the PortalData web service. Each String constant represents some attribute. The description of each attribute key includes the type of the attribute in italics.

All fields listed are read from the system and are retrievable via the PortalObject objects (except when unsupported and thus noted in grey).  Furthermore, fields that are settable (currently for TroubleTicket, Note) are a subset of all available fields are noted accordingly.

Please refer to specific calls for examples of reading/writing.


Field Summary
static String EVENT_ATTR_ACKGID
          Event Ack GID String
static String EVENT_ATTR_ACKIDENTIFIER
          Event Ack Identifier String
static String EVENT_ATTR_ACKNOWLEDGED
          Event Acknowledge Flag String
static String EVENT_ATTR_ACKTIME
          Event Ack Time String
static String EVENT_ATTR_ACKUID
          Event Ack UID String
static String EVENT_ATTR_AGENT
          Event Agent Name String
static String EVENT_ATTR_ALERTGROUP
          Event Alert Group Value String
static String EVENT_ATTR_ALERTKEY
          Event Alert Key Value String
static String EVENT_ATTR_CLASS
          Event Class Value String
static String EVENT_ATTR_CMDBIDENTIFIER
          Event CMDB Identifier String
static String EVENT_ATTR_CMDBNAME
          Event CMDB Name String
static String EVENT_ATTR_COMPONENTGROUP
          Event Component Group String
static String EVENT_ATTR_COMPONENTNAME
          Event Component Name String
static String EVENT_ATTR_CUSTOMER
          Event Customer Name String
static String EVENT_ATTR_CUSTOMERID
          Event Customer ID String
static String EVENT_ATTR_DEVICEVENDOR
          Event Device Vandor Name String
static String EVENT_ATTR_EVENTID
          Event Event ID String
static String EVENT_ATTR_EXPIRETIME
          Event Expire Time String
static String EVENT_ATTR_FIRSTOCCURRENCE
          Event First Occurrence Value String
static String EVENT_ATTR_GRADE
          Event Grade Value String
static String EVENT_ATTR_GROUPCUSTOMER
          Event Group Customer Name String
static String EVENT_ATTR_GROUPDEVICETYPE
          Event Group Device Type String
static String EVENT_ATTR_GROUPREGION
          Event Group Region Name String
static String EVENT_ATTR_GROUPSERVICE
          Event Group Service Name String
static String EVENT_ATTR_GROUPSERVICELEVEL
          Event Group Service Level Value String
static String EVENT_ATTR_GROUPSLAGROUP
          Event Group SLA Value String
static String EVENT_ATTR_HISTORYINSERTIONDATE
          Event History Insertion Date Value String
static String EVENT_ATTR_INTERNALLAST
          Event INTERNALLAST Value String
static String EVENT_ATTR_IP2
          Event IP2 Value String
static String EVENT_ATTR_IP3
          Event IP3 Value String
static String EVENT_ATTR_LASTOCCURRENCE
          Event Last Occurrence Time String
static String EVENT_ATTR_MANAGER
          Event Manager Name String
static String EVENT_ATTR_NODE
          Event Node Name String
static String EVENT_ATTR_NODEALIAS
          Event Node Details String
static String EVENT_ATTR_OLDROOTID
          Event Old Root ID String
static String EVENT_ATTR_OWNERGID
          Event Owner GID String
static String EVENT_ATTR_OWNERNAME
          Event Owner Name String
static String EVENT_ATTR_OWNERUID
          Event Owner UID String
static String EVENT_ATTR_PARENTID
          Event Parent ID String
static String EVENT_ATTR_PHYSICALSITECITY
          Event Physical Site City Name String
static String EVENT_ATTR_PHYSICALSITEID
          Event Physical Site ID String
static String EVENT_ATTR_POLL
          Event Poll Value String
static String EVENT_ATTR_ROOTID
          Event Root ID String
static String EVENT_ATTR_SERIAL
          Event Serial Value String
static String EVENT_ATTR_SERVERNAME
          Event Server Name String
static String EVENT_ATTR_SERVERSERIAL
          Event Server Serial Value String
static String EVENT_ATTR_SEVERITY
          Event Severity Value String
static String EVENT_ATTR_SIPID
          Event SIP ID String
static String EVENT_ATTR_SITEID
          Event Site ID String
static String EVENT_ATTR_STATECHANGE
          Event State Change Value String
static String EVENT_ATTR_SUBCUSTOMER
          Event Subcustomer Name String
static String EVENT_ATTR_SUMMARY
          Event Summary Information String
static String EVENT_ATTR_TALLY
          Event Tally Value String
static String EVENT_ATTR_TICKETID
          Event Ticket ID String
static String EVENT_ATTR_TICKETSYSTEM
          Event Ticket System Name String
static String EVENT_ATTR_TYPE
          Event Type Value String
static String EVENT_ATTR_URL
          Event URL Value String
static String EVENT_ATTR_VARBINDS
          Event VARBINDS Value String
static String EVENT_JOURNAL_ATTR_CREATED_TIME
          Event Journal Created Time as yyyy-mm-dd hh:mm String
static String EVENT_JOURNAL_ATTR_EVENT_ID
          Event Journal Event Owner's Unique Identifier String
static String EVENT_JOURNAL_ATTR_JOURNAL_ID
          Event Journal Unique Identifier String
static String EVENT_JOURNAL_ATTR_TEXT
          Ticket Journal Text/Details String
static String TICKET_ATTR_ADDRESS
          Ticket Address as Address1 + City + Zip String
static String TICKET_ATTR_AIP_ID
          Ticket AIP association Integer
static String TICKET_ATTR_CUSTOMER_ID
          Ticket Customer (Company) ID Integer
static String TICKET_ATTR_CUSTOMER_XREF
          Ticket Customer X Reference (for eBonding purposes)String
static String TICKET_ATTR_DATE_CLOSED
          Ticket Close Date as yyyy-mm-dd hh:mm String
static String TICKET_ATTR_DATE_OPENED
          Ticket Open Date as yyyy-mm-dd hh:mm String
static String TICKET_ATTR_DESCRIPTION
          Ticket Description/Summary  String

NOTE: This field is currently not being set during ticket reading

static String TICKET_ATTR_ESCALATED_TO
          Integer Escalated to first name + last name String
static String TICKET_ATTR_GUID
          Ticket Unique Identifying GUID String
static String TICKET_ATTR_ID
          Ticket Unique Identifier Integer

Also used when creating a new ticket note

static String TICKET_ATTR_ATTACHMENT_NAME
          Indicates that an attachment has been posted during the ticket update operation.  This will be filename used when attaching the file to the ticket.  Currently there is a 20MB limit on any single attachment.

Used optionally when calling updateTicket

static String TICKET_ATTR_INST_PROD_ID
          Ticket Installed Product ID association Integer
static String TICKET_ATTR_LOGICAL_SITE_ID
          Ticket Logical Site ID as a String Integer

Also used when creating a new ticket

static String TICKET_ATTR_NOTES
          List of Notes Associated with Ticket PortalObject[] with 'Note' object name
static String TICKET_ATTR_ORIGIN
          Ticket Origin Description String
static String TICKET_ATTR_PRIORITY
          Ticket Priority String

Also used when creating a new ticket (must be one of: '1 - Urgent', '2 - High', '3 - Medium', or '4 - Low')

static String TICKET_ATTR_REASON
          Ticket Open Reason String
static String TICKET_ATTR_RELATED_SERVICE_NAME
          Ticket Service Name Association String

NOTE: This field is currently not being set during ticket reading

static String TICKET_ATTR_REPORTED_BY
          Reporter first name + last name String

Also used when creating a new ticket

static String TICKET_ATTR_RESOLUTION
          Ticket Resolution When Closed String

NOTE: This field is currently not being set during ticket reading

static String TICKET_ATTR_SIP_ID
          Ticket SIP association Integer
static String TICKET_ATTR_SITE_ID
          Ticket Unique Site ID Integer
static String TICKET_ATTR_SITE_NAME
          Ticket Site Name String
static String TICKET_ATTR_STATUS
          Ticket Status String
static String TICKET_ATTR_SUBJECT
          Ticket Subject Line String

Also used when creating a new ticket

static String TICKET_ATTR_TYPE
          Ticket Type String

Also used when creating a new ticket (must be one of: 'Hosting Request', 'Hosting Incident', 'Network Incident', or 'Network Request' )

static String TICKET_NOTE_ATTR_ACTION
          Ticket Journal Action TextString
static String TICKET_NOTE_ATTR_CREATED_BY
          Ticket Creator String
static String TICKET_NOTE_ATTR_DATE_CREATED
          Ticket Journal Creation Date as yyyy-mm-dd hh:mm String
static String TICKET_NOTE_ATTR_DETAIL
          Ticket Journal Details/Text  String

Also used when creating a new ticket note

static String TICKET_NOTE_ATTR_DETAIL_HTML
          Ticket Journal Details/Text as HTML String

Also used when creating a new ticket note

static String TICKET_NOTE_ATTR_SUBJECT
          Ticket Journal Subject Line String

Also used when creating a new ticket note

static String MAINTENANCE_ATTR_ACTIVITY_TYPE
          Future Maintenance activity type String
static String MAINTENANCE_ATTR_APPROVED_DATE
          Maintenance Activity date this request was approved java.util.Date
static String MAINTENANCE_ATTR_CATEGORY
          Maintenance Activity category this activity falls into String
static String MAINTENANCE_ATTR_CUSTOMER_REF
          Maintenance Activity customer reference value String
static String MAINTENANCE_ATTR_DESCRIPTION
          Maintenance Activity description of activity String
static String MAINTENANCE_ATTR_DEVICE_IDS
          Maintenance Activity device ids related to the activity stored into an array Integer[]
static String MAINTENANCE_ATTR_IMPACT_DCS
          Maintenance Activity impact dcs value String
static String MAINTENANCE_ATTR_IMPACT_HOSTING
          Maintenance Activity hosting impact String
static String MAINTENANCE_ATTR_IMPACT_NETWORK
          Maintenance Activity impact network name String
static String MAINTENANCE_ATTR_IMPACT_SECURITY
          Maintenance Activity security impact String
static String MAINTENANCE_ATTR_INSTRUCTIONS
          Maintenance Activity instructions pertinent to this action String
static String MAINTENANCE_ATTR_LOCATIONS
          Array of Activity Locations indicating affected sites PortalObject[] with 'ActivityLocation' object name; see MAINTENANCE_LOCATION_*
static String MAINTENANCE_ATTR_NOTIFICATION_DETAILS
          Maintenance Activity details attached to the pertaining notification String
static String MAINTENANCE_ATTR_PRIORITY
          Maintenance Activity priority of this activity String
static String MAINTENANCE_ATTR_REQUEST_END_DATE
          Maintenance Activity requested end date of the activity java.util.Date
static String MAINTENANCE_ATTR_REQUEST_START_DATE
          Maintenance Activity requested start date of the activity java.util.Date
static String MAINTENANCE_ATTR_REQUESTED_BY_ID
          Maintenance Activity unique identifier of the person who requested this activity Integer
static String MAINTENANCE_ATTR_STATUS
          Maintenance Activity current status of this activity String
static String MAINTENANCE_ATTR_TIME_SPENT
          Maintenance Activity time spend on current activity String
static String MAINTENANCE_ATTR_TIME_ZONE_ID
          Maintenance Activity timezone id String
static String MAINTENANCE_LOCATION_ATTR_ACCOUNT_TYPE
          Maintenance Location account type String
static String MAINTENANCE_LOCATION_ATTR_ADDRESS
          Maintenance Location address (combination of all address lines) String
static String MAINTENANCE_LOCATION_ATTR_CITY
          Maintenance Location city String
static String MAINTENANCE_LOCATION_ATTR_COUNTRY
          Maintenance Location country String
static String MAINTENANCE_LOCATION_ATTR_REGION
          Maintenance Location region code string String
static String MAINTENANCE_LOCATION_ATTR_STATE
          Maintenance Location state String
static String MAINTENANCE_LOCATION_ATTR_XREF_IPROV_TECNET
          Maintenance Location cross reference value String
static String MAINTENANCE_LOCATION_ATTR_ZIP
          Maintenance Location zip code String
static String OBJECT_ALIAS_ATTR_LONG_NAME
          Service Object alias long display name String
static String OBJECT_ALIAS_ATTR_OBJECT_ID
          Service Object unique identifier Integer
static String OBJECT_ALIAS_ATTR_OBJECT_TYPE
          Service Object type String
static String OBJECT_ALIAS_ATTR_SHORT_NAME
          Service Object alias short display name String
 

 

Constructor Summary
WebServiceConstants()
           

Field Detail

TICKET_ATTR_ID

public static final String TICKET_ATTR_ID
Ticket Unique Identifier Integer

 

See Also:
Constant Field Values

TICKET_ATTR_SITE_ID

public static final String TICKET_ATTR_SITE_ID
Ticket Unique Site ID Integer

 

See Also:
Constant Field Values

TICKET_ATTR_SITE_NAME

public static final String TICKET_ATTR_SITE_NAME
Ticket Site Name String

 

See Also:
Constant Field Values

TICKET_ATTR_LOGICAL_SITE_ID

public static final String TICKET_ATTR_LOGICAL_SITE_ID
Ticket Logical Site ID as a String Integer

 

See Also:
Constant Field Values

TICKET_ATTR_ADDRESS

public static final String TICKET_ATTR_ADDRESS
Ticket Address as Address1 + City + Zip String

 

See Also:
Constant Field Values

TICKET_ATTR_CUSTOMER_ID

public static final String TICKET_ATTR_CUSTOMER_ID
Ticket Customer (Company) ID Integer

 

See Also:
Constant Field Values

TICKET_ATTR_CUSTOMER_XREF

public static final String TICKET_ATTR_CUSTOMER_XREF
Ticket Customer X Reference (for eBonding purposes) String

 

See Also:
Constant Field Values

TICKET_ATTR_REPORTED_BY

public static final String TICKET_ATTR_REPORTED_BY
Reporter first name + last name String

 

See Also:
Constant Field Values

TICKET_ATTR_ESCALATED_TO

public static final String TICKET_ATTR_ESCALATED_TO
Integer Escalated to first name + last name String

 

See Also:
Constant Field Values

TICKET_ATTR_TYPE

public static final String TICKET_ATTR_TYPE
Ticket Type String

 

See Also:
Constant Field Values

TICKET_ATTR_SIP_ID

public static final String TICKET_ATTR_SIP_ID
Ticket SIP association Integer

 

See Also:
Constant Field Values

TICKET_ATTR_AIP_ID

public static final String TICKET_ATTR_AIP_ID
Ticket AIP association Integer

 

See Also:
Constant Field Values

TICKET_ATTR_INST_PROD_ID

public static final String TICKET_ATTR_INST_PROD_ID
Ticket Installed Product ID association Integer

 

See Also:
Constant Field Values

TICKET_ATTR_STATUS

public static final String TICKET_ATTR_STATUS
Ticket Status String

 

See Also:
Constant Field Values

TICKET_ATTR_PRIORITY

public static final String TICKET_ATTR_PRIORITY
Ticket Priority String

 

See Also:
Constant Field Values

TICKET_ATTR_SUBJECT

public static final String TICKET_ATTR_SUBJECT
Ticket Subject Line String

 

See Also:
Constant Field Values

TICKET_ATTR_DATE_OPENED

public static final String TICKET_ATTR_DATE_OPENED
Ticket Open Date as yyyy-mm-dd hh:mm String

 

See Also:
Constant Field Values

TICKET_ATTR_DATE_CLOSED

public static final String TICKET_ATTR_DATE_CLOSED
Ticket Close Date as yyyy-mm-dd hh:mm String

 

See Also:
Constant Field Values

TICKET_ATTR_ORIGIN

public static final String TICKET_ATTR_ORIGIN
Ticket Origin Description String

 

See Also:
Constant Field Values

TICKET_ATTR_REASON

public static final String TICKET_ATTR_REASON
Ticket Open Reason String

 

See Also:
Constant Field Values

TICKET_ATTR_RELATED_SERVICE_NAME

public static final String TICKET_ATTR_RELATED_SERVICE_NAME
Ticket Service Name Association String

 

See Also:
Constant Field Values

TICKET_ATTR_GUID

public static final String TICKET_ATTR_GUID
Ticket Unique Identifying GUID String

 

See Also:
Constant Field Values

TICKET_ATTR_DESCRIPTION

public static final String TICKET_ATTR_DESCRIPTION
Ticket Description/Summary String

 

See Also:
Constant Field Values

TICKET_ATTR_RESOLUTION

public static final String TICKET_ATTR_RESOLUTION
Ticket Resolution When Closed String

 

See Also:
Constant Field Values

TICKET_ATTR_NOTES

public static final String TICKET_ATTR_NOTES
List of Notes Associated with Ticket PortalObject[] with 'Note' object name

 

See Also:
Constant Field Values

TICKET_NOTE_ATTR_SUBJECT

public static final String TICKET_NOTE_ATTR_SUBJECT
Ticket Journal Subject Line String

 

See Also:
Constant Field Values

TICKET_NOTE_ATTR_ACTION

public static final String TICKET_NOTE_ATTR_ACTION
Ticket Journal Action TextString

 

See Also:
Constant Field Values

TICKET_NOTE_ATTR_DETAIL

public static final String TICKET_NOTE_ATTR_DETAIL
Ticket Journal Details/Text String

 

See Also:
Constant Field Values

TICKET_NOTE_ATTR_DETAIL_HTML

public static final String TICKET_NOTE_ATTR_DETAIL_HTML
Ticket Journal Details/Text as HTML String

 

See Also:
Constant Field Values

TICKET_NOTE_ATTR_DATE_CREATED

public static final String TICKET_NOTE_ATTR_DATE_CREATED
Ticket Journal Creation Date as yyyy-mm-dd hh:mm String

 

See Also:
Constant Field Values

TICKET_NOTE_ATTR_CREATED_BY

public static final String TICKET_NOTE_ATTR_CREATED_BY
Ticket Creator String

 

See Also:
Constant Field Values

EVENT_ATTR_NODE

public static final String EVENT_ATTR_NODE
See Also:
Constant Field Values

EVENT_ATTR_NODEALIAS

public static final String EVENT_ATTR_NODEALIAS
See Also:
Constant Field Values

EVENT_ATTR_OLDROOTID

public static final String EVENT_ATTR_OLDROOTID
See Also:
Constant Field Values

EVENT_ATTR_OWNERNAME

public static final String EVENT_ATTR_OWNERNAME
See Also:
Constant Field Values

EVENT_ATTR_OWNERGID

public static final String EVENT_ATTR_OWNERGID
See Also:
Constant Field Values

EVENT_ATTR_OWNERUID

public static final String EVENT_ATTR_OWNERUID
See Also:
Constant Field Values

EVENT_ATTR_PARENTID

public static final String EVENT_ATTR_PARENTID
See Also:
Constant Field Values

EVENT_ATTR_PHYSICALSITECITY

public static final String EVENT_ATTR_PHYSICALSITECITY
See Also:
Constant Field Values

EVENT_ATTR_PHYSICALSITEID

public static final String EVENT_ATTR_PHYSICALSITEID
See Also:
Constant Field Values

EVENT_ATTR_POLL

public static final String EVENT_ATTR_POLL
See Also:
Constant Field Values

EVENT_ATTR_ROOTID

public static final String EVENT_ATTR_ROOTID
See Also:
Constant Field Values

EVENT_ATTR_SERVERNAME

public static final String EVENT_ATTR_SERVERNAME
See Also:
Constant Field Values

EVENT_ATTR_SIPID

public static final String EVENT_ATTR_SIPID
See Also:
Constant Field Values

EVENT_ATTR_SITEID

public static final String EVENT_ATTR_SITEID
See Also:
Constant Field Values

EVENT_ATTR_STATECHANGE

public static final String EVENT_ATTR_STATECHANGE
See Also:
Constant Field Values

EVENT_ATTR_SUBCUSTOMER

public static final String EVENT_ATTR_SUBCUSTOMER
See Also:
Constant Field Values

EVENT_ATTR_SUMMARY

public static final String EVENT_ATTR_SUMMARY
See Also:
Constant Field Values

EVENT_ATTR_SERIAL

public static final String EVENT_ATTR_SERIAL
See Also:
Constant Field Values

EVENT_ATTR_SERVERSERIAL

public static final String EVENT_ATTR_SERVERSERIAL
See Also:
Constant Field Values

EVENT_ATTR_SEVERITY

public static final String EVENT_ATTR_SEVERITY
See Also:
Constant Field Values

EVENT_ATTR_TICKETID

public static final String EVENT_ATTR_TICKETID
See Also:
Constant Field Values

EVENT_ATTR_TICKETSYSTEM

public static final String EVENT_ATTR_TICKETSYSTEM
See Also:
Constant Field Values

EVENT_ATTR_TALLY

public static final String EVENT_ATTR_TALLY
See Also:
Constant Field Values

EVENT_ATTR_TYPE

public static final String EVENT_ATTR_TYPE
See Also:
Constant Field Values

EVENT_ATTR_URL

public static final String EVENT_ATTR_URL
See Also:
Constant Field Values

EVENT_ATTR_VARBINDS

public static final String EVENT_ATTR_VARBINDS
See Also:
Constant Field Values

EVENT_ATTR_MANAGER

public static final String EVENT_ATTR_MANAGER
See Also:
Constant Field Values

EVENT_ATTR_LASTOCCURRENCE

public static final String EVENT_ATTR_LASTOCCURRENCE
See Also:
Constant Field Values

EVENT_ATTR_IP3

public static final String EVENT_ATTR_IP3
See Also:
Constant Field Values

EVENT_ATTR_IP2

public static final String EVENT_ATTR_IP2
See Also:
Constant Field Values

EVENT_ATTR_INTERNALLAST

public static final String EVENT_ATTR_INTERNALLAST
See Also:
Constant Field Values

EVENT_ATTR_HISTORYINSERTIONDATE

public static final String EVENT_ATTR_HISTORYINSERTIONDATE
See Also:
Constant Field Values

EVENT_ATTR_GRADE

public static final String EVENT_ATTR_GRADE
See Also:
Constant Field Values

EVENT_ATTR_GROUPSLAGROUP

public static final String EVENT_ATTR_GROUPSLAGROUP
See Also:
Constant Field Values

EVENT_ATTR_GROUPSERVICELEVEL

public static final String EVENT_ATTR_GROUPSERVICELEVEL
See Also:
Constant Field Values

EVENT_ATTR_GROUPSERVICE

public static final String EVENT_ATTR_GROUPSERVICE
See Also:
Constant Field Values

EVENT_ATTR_GROUPREGION

public static final String EVENT_ATTR_GROUPREGION
See Also:
Constant Field Values

EVENT_ATTR_GROUPDEVICETYPE

public static final String EVENT_ATTR_GROUPDEVICETYPE
See Also:
Constant Field Values

EVENT_ATTR_GROUPCUSTOMER

public static final String EVENT_ATTR_GROUPCUSTOMER
See Also:
Constant Field Values

EVENT_ATTR_FIRSTOCCURRENCE

public static final String EVENT_ATTR_FIRSTOCCURRENCE
See Also:
Constant Field Values

EVENT_ATTR_EXPIRETIME

public static final String EVENT_ATTR_EXPIRETIME
See Also:
Constant Field Values

EVENT_ATTR_CLASS

public static final String EVENT_ATTR_CLASS
See Also:
Constant Field Values

EVENT_ATTR_EVENTID

public static final String EVENT_ATTR_EVENTID
See Also:
Constant Field Values

EVENT_ATTR_DEVICEVENDOR

public static final String EVENT_ATTR_DEVICEVENDOR
See Also:
Constant Field Values

EVENT_ATTR_CMDBIDENTIFIER

public static final String EVENT_ATTR_CMDBIDENTIFIER
See Also:
Constant Field Values

EVENT_ATTR_CUSTOMERID

public static final String EVENT_ATTR_CUSTOMERID
See Also:
Constant Field Values

EVENT_ATTR_CUSTOMER

public static final String EVENT_ATTR_CUSTOMER
See Also:
Constant Field Values

EVENT_ATTR_COMPONENTNAME

public static final String EVENT_ATTR_COMPONENTNAME
See Also:
Constant Field Values

EVENT_ATTR_COMPONENTGROUP

public static final String EVENT_ATTR_COMPONENTGROUP
See Also:
Constant Field Values

EVENT_ATTR_CMDBNAME

public static final String EVENT_ATTR_CMDBNAME
See Also:
Constant Field Values

EVENT_ATTR_ALERTKEY

public static final String EVENT_ATTR_ALERTKEY
See Also:
Constant Field Values

EVENT_ATTR_ALERTGROUP

public static final String EVENT_ATTR_ALERTGROUP
See Also:
Constant Field Values

EVENT_ATTR_AGENT

public static final String EVENT_ATTR_AGENT
See Also:
Constant Field Values

EVENT_ATTR_ACKTIME

public static final String EVENT_ATTR_ACKTIME
See Also:
Constant Field Values

EVENT_ATTR_ACKIDENTIFIER

public static final String EVENT_ATTR_ACKIDENTIFIER
See Also:
Constant Field Values

EVENT_ATTR_ACKUID

public static final String EVENT_ATTR_ACKUID
See Also:
Constant Field Values

EVENT_ATTR_ACKNOWLEDGED

public static final String EVENT_ATTR_ACKNOWLEDGED
See Also:
Constant Field Values

EVENT_ATTR_ACKGID

public static final String EVENT_ATTR_ACKGID
See Also:
Constant Field Values

EVENT_JOURNAL_ATTR_CREATED_TIME

public static final String EVENT_JOURNAL_ATTR_CREATED_TIME
Event Journal Created Time as yyyy-mm-dd hh:mm String

 

See Also:
Constant Field Values

EVENT_JOURNAL_ATTR_TEXT

public static final String EVENT_JOURNAL_ATTR_TEXT
Ticket Journal Text/Details String

 

See Also:
Constant Field Values

EVENT_JOURNAL_ATTR_EVENT_ID

public static final String EVENT_JOURNAL_ATTR_EVENT_ID
Event Journal Event Owner's Unique Identifier String

 

See Also:
Constant Field Values

EVENT_JOURNAL_ATTR_JOURNAL_ID

public static final String EVENT_JOURNAL_ATTR_JOURNAL_ID
Event Journal Unique Identifier String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_ACTIVITY_TYPE

public static final java.lang.String MAINTENANCE_ATTR_ACTIVITY_TYPE
Future Maintenance activity type java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_STATUS

public static final java.lang.String MAINTENANCE_ATTR_STATUS
Maintenance Activity current status of this activity java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_PRIORITY

public static final java.lang.String MAINTENANCE_ATTR_PRIORITY
Maintenance Activity priority of this activity java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_CATEGORY

public static final java.lang.String MAINTENANCE_ATTR_CATEGORY
Maintenance Activity category this activity falls into java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_REQUEST_START_DATE

public static final java.lang.String MAINTENANCE_ATTR_REQUEST_START_DATE
Maintenance Activity requested start date of the activity java.util.Date

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_REQUEST_END_DATE

public static final java.lang.String MAINTENANCE_ATTR_REQUEST_END_DATE
Maintenance Activity requested end date of the activity java.util.Date

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_APPROVED_DATE

public static final java.lang.String MAINTENANCE_ATTR_APPROVED_DATE
Maintenance Activity date this request was approved java.util.Date

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_NOTIFICATION_DETAILS

public static final java.lang.String MAINTENANCE_ATTR_NOTIFICATION_DETAILS
Maintenance Activity details attached to the pertaining notification java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_REQUESTED_BY_ID

public static final java.lang.String MAINTENANCE_ATTR_REQUESTED_BY_ID
Maintenance Activity unique identifier of the person who requested this activity java.lang.Integer

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_DESCRIPTION

public static final java.lang.String MAINTENANCE_ATTR_DESCRIPTION
Maintenance Activity description of activity java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_TIME_SPENT

public static final java.lang.String MAINTENANCE_ATTR_TIME_SPENT
Maintenance Activity time spend on current activity java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_IMPACT_HOSTING

public static final java.lang.String MAINTENANCE_ATTR_IMPACT_HOSTING
Maintenance Activity hosting impact java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_IMPACT_SECURITY

public static final java.lang.String MAINTENANCE_ATTR_IMPACT_SECURITY
Maintenance Activity security impact java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_IMPACT_DCS

public static final java.lang.String MAINTENANCE_ATTR_IMPACT_DCS
Maintenance Activity impact dcs value java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_IMPACT_NETWORK

public static final java.lang.String MAINTENANCE_ATTR_IMPACT_NETWORK
Maintenance Activity impact network name java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_TIME_ZONE_ID

public static final java.lang.String MAINTENANCE_ATTR_TIME_ZONE_ID
Maintenance Activity timezone id java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_DEVICE_IDS

public static final java.lang.String MAINTENANCE_ATTR_DEVICE_IDS
Maintenance Activity device ids related to the activity stored into an array java.lang.Integer[]

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_CUSTOMER_REF

public static final java.lang.String MAINTENANCE_ATTR_CUSTOMER_REF
Maintenance Activity customer reference value java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_INSTRUCTIONS

public static final java.lang.String MAINTENANCE_ATTR_INSTRUCTIONS
Maintenance Activity instructions pertinent to this action java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_ATTR_LOCATIONS

public static final java.lang.String MAINTENANCE_ATTR_LOCATIONS
Array of Activity Locations indicating affected sites PortalObject[] with 'ActivityLocation' object name; see MAINTENANCE_LOCATION_*

 

See Also:
Constant Field Values

MAINTENANCE_LOCATION_ATTR_ADDRESS

public static final java.lang.String MAINTENANCE_LOCATION_ATTR_ADDRESS
Maintenance Location address (combination of all address lines) java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_LOCATION_ATTR_CITY

public static final java.lang.String MAINTENANCE_LOCATION_ATTR_CITY
Maintenance Location city java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_LOCATION_ATTR_STATE

public static final java.lang.String MAINTENANCE_LOCATION_ATTR_STATE
Maintenance Location state java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_LOCATION_ATTR_REGION

public static final java.lang.String MAINTENANCE_LOCATION_ATTR_REGION
Maintenance Location region code string java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_LOCATION_ATTR_ZIP

public static final java.lang.String MAINTENANCE_LOCATION_ATTR_ZIP
Maintenance Location zip code java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_LOCATION_ATTR_COUNTRY

public static final java.lang.String MAINTENANCE_LOCATION_ATTR_COUNTRY
Maintenance Location country java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_LOCATION_ATTR_ACCOUNT_TYPE

public static final java.lang.String MAINTENANCE_LOCATION_ATTR_ACCOUNT_TYPE
Maintenance Location account type java.lang.String

 

See Also:
Constant Field Values

MAINTENANCE_LOCATION_ATTR_XREF_IPROV_TECNET

public static final java.lang.String MAINTENANCE_LOCATION_ATTR_XREF_IPROV_TECNET
Maintenance Location cross reference value java.lang.String

 

See Also:
Constant Field Values

OBJECT_ALIAS_ATTR_OBJECT_TYPE

public static final java.lang.String OBJECT_ALIAS_ATTR_OBJECT_TYPE
Service Object type java.lang.String

 

See Also:
Constant Field Values

OBJECT_ALIAS_ATTR_OBJECT_ID

public static final java.lang.String OBJECT_ALIAS_ATTR_OBJECT_ID
Service Object unique identifier java.lang.Integer

 

See Also:
Constant Field Values

OBJECT_ALIAS_ATTR_SHORT_NAME

public static final java.lang.String OBJECT_ALIAS_ATTR_SHORT_NAME
Service Object alias short display name java.lang.String

 

See Also:
Constant Field Values

OBJECT_ALIAS_ATTR_LONG_NAME

public static final java.lang.String OBJECT_ALIAS_ATTR_LONG_NAME
Service Object alias long display name java.lang.String

 

See Also:
Constant Field Values

 

 
Constructor Detail

WebServiceConstants

public WebServiceConstants()

 

Constant Field Values Summary


PortalData
public static final String EVENT_PROPERTY_ALERT_GROUP "EVENT_PROPERTY_ALERT_GROUP"
public static final String EVENT_PROPERTY_ALERT_KEY "EVENT_PROPERTY_ALERT_KEY"
public static final String EVENT_PROPERTY_DATE_RELATIVE "EVENT_PROPERTY_DATE_RELATIVE"
public static final String EVENT_PROPERTY_END_DATE "EVENT_PROPERTY_END_DATE"
public static final String EVENT_PROPERTY_NODE "EVENT_PROPERTY_NODE"
public static final String EVENT_PROPERTY_SERIAL "EVENT_PROPERTY_SERIAL"
public static final String EVENT_PROPERTY_SEVERITY "EVENT_PROPERTY_SEVERITY"
public static final String EVENT_PROPERTY_SITE "EVENT_PROPERTY_SITE"
public static final String EVENT_PROPERTY_START_DATE "EVENT_PROPERTY_START_DATE"
public static final String PROPERTY_FETCH_SIZE "PROPERTY_FETCH_SIZE"
public static final String PROPERTY_EVENT_DAYS_MAX "PROPERTY_EVENT_DAYS_MAX"
public static final String PROPERTY_TICKET_DAYS_MAX "PROPERTY_TICKET_DAYS_MAX"
public static final String TICKET_PROPERTY_END_DATE "TICKET_PROPERTY_END_DATE"
public static final String TICKET_PROPERTY_NOTES "TICKET_PROPERTY_NOTES"
public static final String TICKET_PROPERTY_OPEN "TICKET_PROPERTY_OPEN"
public static final String TICKET_PROPERTY_START_DATE "TICKET_PROPERTY_START_DATE"
public static final String TICKET_PROPERTY_XREF "TICKET_PROPERTY_XREF"
public static final String TICKET_PROPERTY_MULTICUSTOMER_SEARCH "TICKET_PROPERTY_MULTICUSTOMER_SEARCH"
public static final String FUTURE_CHANGE_PROPERTY_CUSTOMER_IMPACTING "FUTURE_CHANGE_PROPERTY_CUSTOMER_IMPACTING"
public static final String FUTURE_CHANGE_PROPERTY_WEEKS "FUTURE_CHANGE_PROPERTY_WEEKS"
public static final String FUTURE_CHANGE_PROPERTY_START_DATE "FUTURE_CHANGE_PROPERTY_START_DATE"
public static final String FUTURE_CHANGE_PROPERTY_END_DATE "FUTURE_CHANGE_PROPERTY_END_DATE"

WebServiceConstants
public static final String EVENT_ATTR_ACKGID "EVENT_ATTR_ACKGID"
public static final String EVENT_ATTR_ACKIDENTIFIER "EVENT_ATTR_ACKIDENTIFIER"
public static final String EVENT_ATTR_ACKNOWLEDGED "EVENT_ATTR_ACKNOWLEDGED"
public static final String EVENT_ATTR_ACKTIME "EVENT_ATTR_ACKTIME"
public static final String EVENT_ATTR_ACKUID "EVENT_ATTR_ACKUID"
public static final String EVENT_ATTR_AGENT "EVENT_ATTR_AGENT"
public static final String EVENT_ATTR_ALERTGROUP "EVENT_ATTR_ALERTGROUP"
public static final String EVENT_ATTR_ALERTKEY "EVENT_ATTR_ALERTKEY"
public static final String EVENT_ATTR_CLASS "EVENT_ATTR_CLASS"
public static final String EVENT_ATTR_CMDBIDENTIFIER "EVENT_ATTR_CMDBIDENTIFIER"
public static final String EVENT_ATTR_CMDBNAME "EVENT_ATTR_CMDBNAME"
public static final String EVENT_ATTR_COMPONENTGROUP "EVENT_ATTR_COMPONENTGROUP"
public static final String EVENT_ATTR_COMPONENTNAME "EVENT_ATTR_COMPONENTNAME"
public static final String EVENT_ATTR_CUSTOMER "EVENT_ATTR_CUSTOMER"
public static final String EVENT_ATTR_CUSTOMERID "EVENT_ATTR_CUSTOMERID"
public static final String EVENT_ATTR_DEVICEVENDOR "EVENT_ATTR_DEVICEVENDOR"
public static final String EVENT_ATTR_EVENTID "EVENT_ATTR_EVENTID"
public static final String EVENT_ATTR_EXITCONDITION "EVENT_ATTR_EXITCONDITION"
public static final String EVENT_ATTR_EXPIRETIME "EVENT_ATTR_EXPIRETIME"
public static final String EVENT_ATTR_FIRSTOCCURRENCE "EVENT_ATTR_FIRSTOCCURRENCE"
public static final String EVENT_ATTR_GRADE "EVENT_ATTR_GRADE"
public static final String EVENT_ATTR_GROUPCUSTOMER "EVENT_ATTR_GROUPCUSTOMER"
public static final String EVENT_ATTR_GROUPDEVICETYPE "EVENT_ATTR_GROUPDEVICETYPE"
public static final String EVENT_ATTR_GROUPREGION "EVENT_ATTR_GROUPREGION"
public static final String EVENT_ATTR_GROUPSERVICE "EVENT_ATTR_GROUPSERVICE"
public static final String EVENT_ATTR_GROUPSERVICELEVEL "EVENT_ATTR_GROUPSERVICELEVEL"
public static final String EVENT_ATTR_GROUPSLAGROUP "EVENT_ATTR_GROUPSLAGROUP"
public static final String EVENT_ATTR_HISTORYINSERTIONDATE "EVENT_ATTR_HISTORYINSERTIONDATE"
public static final String EVENT_ATTR_INTERNALLAST "EVENT_ATTR_INTERNALLAST"
public static final String EVENT_ATTR_IP2 "EVENT_ATTR_IP2"
public static final String EVENT_ATTR_IP3 "EVENT_ATTR_IP3"
public static final String EVENT_ATTR_LASTOCCURRENCE "EVENT_ATTR_LASTOCCURRENCE"
public static final String EVENT_ATTR_MANAGER "EVENT_ATTR_MANAGER"
public static final String EVENT_ATTR_NODE "EVENT_ATTR_NODE"
public static final String EVENT_ATTR_NODEALIAS "EVENT_ATTR_NODEALIAS"
public static final String EVENT_ATTR_OLDROOTID "EVENT_ATTR_OLDROOTID"
public static final String EVENT_ATTR_OWNERGID "EVENT_ATTR_OWNERGID"
public static final String EVENT_ATTR_OWNERNAME "EVENT_ATTR_OWNERNAME"
public static final String EVENT_ATTR_OWNERUID "EVENT_ATTR_OWNERUID"
public static final String EVENT_ATTR_PARENTID "EVENT_ATTR_PARENTID"
public static final String EVENT_ATTR_PHYSICALSITECITY "EVENT_ATTR_PHYSICALSITECITY"
public static final String EVENT_ATTR_PHYSICALSITEID "EVENT_ATTR_PHYSICALSITEID"
public static final String EVENT_ATTR_POLL "EVENT_ATTR_POLL"
public static final String EVENT_ATTR_ROOTID "EVENT_ATTR_ROOTID"
public static final String EVENT_ATTR_SERIAL "EVENT_ATTR_SERIAL"
public static final String EVENT_ATTR_SERVERNAME "EVENT_ATTR_SERVERNAME"
public static final String EVENT_ATTR_SERVERSERIAL "EVENT_ATTR_SERVERSERIAL"
public static final String EVENT_ATTR_SEVERITY "EVENT_ATTR_SEVERITY"
public static final String EVENT_ATTR_SIPID "EVENT_ATTR_SIPID"
public static final String EVENT_ATTR_SITEID "EVENT_ATTR_SITEID"
public static final String EVENT_ATTR_STATECHANGE "EVENT_ATTR_STATECHANGE"
public static final String EVENT_ATTR_SUBCUSTOMER "EVENT_ATTR_SUBCUSTOMER"
public static final String EVENT_ATTR_SUMMARY "EVENT_ATTR_SUMMARY"
public static final String EVENT_ATTR_TALLY "EVENT_ATTR_TALLY"
public static final String EVENT_ATTR_TICKETID "EVENT_ATTR_TICKETID"
public static final String EVENT_ATTR_TICKETSYSTEM "EVENT_ATTR_TICKETSYSTEM"
public static final String EVENT_ATTR_TYPE "EVENT_ATTR_TYPE"
public static final String EVENT_ATTR_URL "EVENT_ATTR_URL"
public static final String EVENT_ATTR_VARBINDS "EVENT_ATTR_VARBINDS"
public static final String EVENT_JOURNAL_ATTR_CREATED_TIME "JOURNAL_ATTR_CREATED_TIME"
public static final String EVENT_JOURNAL_ATTR_EVENT_ID "JOURNAL_ATTR_EVENT_ID"
public static final String EVENT_JOURNAL_ATTR_JOURNAL_ID "JOURNAL_ATTR_JOURNAL_ID"
public static final String EVENT_JOURNAL_ATTR_TEXT "JOURNAL_ATTR_TEXT"
public static final String TICKET_ATTR_ADDRESS "TICKET_ATTR_ADDRESS"
public static final String TICKET_ATTR_AIP_ID "TICKET_ATTR_AIP_ID"
public static final String TICKET_ATTR_CUSTOMER_ID "TICKET_ATTR_CUSTOMER_ID"
public static final String TICKET_ATTR_CUSTOMER_XREF "TICKET_ATTR_CUSTOMER_XREF"
public static final String TICKET_ATTR_DATE_CLOSED "TICKET_ATTR_DATE_CLOSED"
public static final String TICKET_ATTR_DATE_OPENED "TICKET_ATTR_DATE_OPENED"
public static final String TICKET_ATTR_DESCRIPTION "TICKET_ATTR_DESCRIPTION"
public static final String TICKET_ATTR_ESCALATED_TO "TICKET_ATTR_ESCALATED_TO"
public static final String TICKET_ATTR_GUID "TICKET_ATTR_GUID"
public static final String TICKET_ATTR_ID "TICKET_ATTR_ID"
public static final String TICKET_ATTR_ATTACHMENT_NAME "TICKET_ATTR_ATTACHMENT_NAME"
public static final String TICKET_ATTR_INST_PROD_ID "TICKET_ATTR_INST_PROD_ID"
public static final String TICKET_ATTR_LOGICAL_SITE_ID "TICKET_ATTR_LOGICAL_SITE_ID"
public static final String TICKET_ATTR_NOTES "TICKET_ATTR_NOTES"
public static final String TICKET_ATTR_ORIGIN "TICKET_ATTR_ORIGIN"
public static final String TICKET_ATTR_PRIORITY "TICKET_ATTR_PRIORITY"
public static final String TICKET_ATTR_REASON "TICKET_ATTR_REASON"
public static final String TICKET_ATTR_RELATED_SERVICE_NAME "TICKET_ATTR_RELATED_SERVICE_NAME"
public static final String TICKET_ATTR_REPORTED_BY "TICKET_ATTR_REPORTED_BY"
public static final String TICKET_ATTR_RESOLUTION "TICKET_ATTR_RESOLUTION"
public static final String TICKET_ATTR_SIP_ID "TICKET_ATTR_SIP_ID"
public static final String TICKET_ATTR_SITE_ID "TICKET_ATTR_SITE_ID"
public static final String TICKET_ATTR_SITE_NAME "TICKET_ATTR_SITE_NAME"
public static final String TICKET_ATTR_STATUS "TICKET_ATTR_STATUS"
public static final String TICKET_ATTR_SUBJECT "TICKET_ATTR_SUBJECT"
public static final String TICKET_ATTR_TYPE "TICKET_ATTR_TYPE"
public static final String TICKET_NOTE_ATTR_ACTION "TICKET_NOTE_ATTR_ACTION"
public static final String TICKET_NOTE_ATTR_CREATED_BY "TICKET_NOTE_ATTR_CREATED_BY"
public static final String TICKET_NOTE_ATTR_DATE_CREATED "TICKET_NOTE_ATTR_DATE_CREATED"
public static final String TICKET_NOTE_ATTR_DETAIL "TICKET_NOTE_ATTR_DETAIL"
public static final String TICKET_NOTE_ATTR_DETAIL_HTML "TICKET_NOTE_ATTR_DETAIL_HTML"
public static final String TICKET_NOTE_ATTR_SUBJECT "TICKET_NOTE_ATTR_SUBJECT"
public static final String MAINTENANCE_ATTR_ACTIVITY_TYPE "MAINTENANCE_ATTR_ACTIVITY_TYPE"
public static final String MAINTENANCE_ATTR_APPROVED_DATE "MAINTENANCE_ATTR_APPROVED_DATE"
public static final String MAINTENANCE_ATTR_CATEGORY "MAINTENANCE_ATTR_CATEGORY"
public static final String MAINTENANCE_ATTR_CUSTOMER_REF "MAINTENANCE_ATTR_CUSTOMER_REF"
public static final String MAINTENANCE_ATTR_DESCRIPTION "MAINTENANCE_ATTR_DESCRIPTION"
public static final String MAINTENANCE_ATTR_DEVICE_IDS "MAINTENANCE_ATTR_DEVICE_IDS"
public static final String MAINTENANCE_ATTR_IMPACT_DCS "MAINTENANCE_ATTR_IMPACT_DCS"
public static final String MAINTENANCE_ATTR_IMPACT_HOSTING "MAINTENANCE_ATTR_IMPACT_HOSTING"
public static final String MAINTENANCE_ATTR_IMPACT_NETWORK "MAINTENANCE_ATTR_IMPACT_NETWORK"
public static final String MAINTENANCE_ATTR_IMPACT_SECURITY "MAINTENANCE_ATTR_IMPACT_SECURITY"
public static final String MAINTENANCE_ATTR_INSTRUCTIONS "MAINTENANCE_ATTR_INSTRUCTIONS"
public static final String MAINTENANCE_ATTR_LOCATIONS "MAINTENANCE_ATTR_LOCATIONS"
public static final String MAINTENANCE_ATTR_NOTIFICATION_DETAILS "MAINTENANCE_ATTR_NOTIFICATION_DETAILS"
public static final String MAINTENANCE_ATTR_PRIORITY "MAINTENANCE_ATTR_PRIORITY"
public static final String MAINTENANCE_ATTR_REQUEST_END_DATE "MAINTENANCE_ATTR_REQUEST_END_DATE"
public static final String MAINTENANCE_ATTR_REQUEST_START_DATE "MAINTENANCE_ATTR_REQUEST_START_DATE"
public static final String MAINTENANCE_ATTR_REQUESTED_BY_ID "MAINTENANCE_ATTR_REQUESTED_BY_ID"
public static final String MAINTENANCE_ATTR_STATUS "MAINTENANCE_ATTR_STATUS"
public static final String MAINTENANCE_ATTR_TIME_SPENT "MAINTENANCE_ATTR_TIME_SPENT"
public static final String MAINTENANCE_ATTR_TIME_ZONE_ID "MAINTENANCE_ATTR_TIME_ZONE_ID"
public static final String MAINTENANCE_LOCATION_ATTR_ACCOUNT_TYPE "MAINTENANCE_LOCATION_ATTR_ACCOUNT_TYPE"
public static final String MAINTENANCE_LOCATION_ATTR_ADDRESS "MAINTENANCE_LOCATION_ATTR_ADDRESS"
public static final String MAINTENANCE_LOCATION_ATTR_CITY "MAINTENANCE_LOCATION_ATTR_CITY"
public static final String MAINTENANCE_LOCATION_ATTR_COUNTRY "MAINTENANCE_LOCATION_ATTR_COUNTRY"
public static final String MAINTENANCE_LOCATION_ATTR_REGION "MAINTENANCE_LOCATION_ATTR_REGION"
public static final String MAINTENANCE_LOCATION_ATTR_STATE "MAINTENANCE_LOCATION_ATTR_STATE"
public static final String MAINTENANCE_LOCATION_ATTR_XREF_IPROV_TECNET "MAINTENANCE_LOCATION_ATTR_XREF_IPROV_TECNET"
public static final Stringng MAINTENANCE_LOCATION_ATTR_ZIP "MAINTENANCE_LOCATION_ATTR_ZIP"
public static final String OBJECT_ALIAS_ATTR_LONG_NAME "OBJECT_ALIAS_ATTR_LONG_NAME"
public static final String OBJECT_ALIAS_ATTR_OBJECT_ID "OBJECT_ALIAS_ATTR_OBJECT_ID"
public static final String OBJECT_ALIAS_ATTR_OBJECT_TYPE "OBJECT_ALIAS_ATTR_OBJECT_TYPE"
public static final String OBJECT_ALIAS_ATTR_SHORT_NAME "OBJECT_ALIAS_ATTR_SHORT_NAME"

 

 


 

Example Client Applications/Code Snippets

#!/usr/bin/perl

#
# This program was tested with perl v5.8.8 built for MSWin32-x86-multi-thread
# Binary build 822 [280952] provided by ActiveState http://www.ActiveState.com
# 
#
# SOAP::Lite needs the following libraries for the SSL communication
#				Crypt-SSLeay and Net_SSLeay 
#



# Uncomment for debugging
# use SOAP::Lite +trace =>  ["debug"];

use SOAP::Lite;
use HTTP::Cookies;



# set this to your user name
my $USER = "testusername";

# set this to your password
my $PASSWORD = "testpassword";

# set this to the service URL
my $serviceURL = "https://www.savvisstation.savvis.com/services/PortalData?wsdl";
my $apiNS = "urn:ccc";

my $timeout = 5;5;

# the credentials are passed in the headermy $header = SOAP::Header->name("authenticate" => \SOAP::Header->value(
   SOAP::Header->name("username" => $USER),
   SOAP::Header->name("password" => $PASSWORD)
   )
);
 
# create cookie variable to store a session
my $cookies = HTTP::Cookies->new(ignore_discard => 1);
   

# establishes service/WSDL object
$service = SOAP::Lite -> service($serviceURL)
		-> uri($apiNS)
		-> readable(1)
		-> proxy($serviceURL, cookie_jar => $cookies, timeout => $timeout);



# call SOAP service
# example: getProperties()

my $method = SOAP::Data->name('getProperties');
my $response = $service->call($method, $header);

if ($response->fault) {
    print $response->faultcode, " ", $response->faultstring, "\n";
    die 'Exiting application ...';
} else {
    my %propMap = %{$response->result};
		
			foreach $key (sort keys %propMap) {
				print "PROPERTY: $key -> $propMap{$key}\n";
			}			
}

.......

/** Java example using Apache Axis **/

/*  Login  Procedure   */

	PortalDataSoapBindingStub binding;
        try {{
            binding = (com.savvis.ui.ccc.data.ws.PortalDataSoapBindingStub)
                          new com.savvis.ui.ccc.data.ws.PortalDataServiceLocator().getPortalData();
        }
        catch (javax.xml.rpc.ServiceException jre) {
            if(jre.getLinkedCause()!=null)
                jre.getLinkedCause().printStackTrace();
            throw new junit.framework.AssertionFailedError("JAX-RPC ServiceException caught: " + jre);
        }
        
        //Log In...
        binding.setMaintainSession(true);
        org.apache.axis.message.SOAPHeaderElement auth = new org.apache.axis.message.SOAPHeaderElement(null, "authenticate", null );
        org.apache.axis.message.SOAPHeaderElement usr = new org.apache.axis.message.SOAPHeaderElement(null, "username", "someusername");
        org.apache.axis.message.SOAPHeaderElement pw = new org.apache.axis.message.SOAPHeaderElement(null, "password", "somepassword");
        auth.addChildElement(usr);
        auth.addChildElement(pw);        binding.setHeader(auth);
 
	/*  Get Tickets  */

	PortalMapItem[] options = new PortalMapItem[3];
   	options[0] = ("TICKET_PROPERTY_OPEN", new Boolean(false));
   	options[1] = ("TICKET_PROPERTY_NOTES", new Boolean(true));
   	options[2] = ("TICKET_PROPERTY_START_DATE", "2008-06-15 00:00");
    	
    	PortalDataSoapBindingStub binding = PortalDataTestHelper.login();

	// Time out after 2 minutes
	binding.setTimeout(240000);

	com.savvis.ui.ccc.data.ws.PortalObject[] value = null;
	value = binding.getTickets(options);
	
	binding.logout();

	//process tickets ... 
 
 	/** Since .NET hides low level SOAP Message manipulation, the required headers are problematic to insert programmatically; **/
	/** This link shows how to insert the Header information **/	
	http://www.codeproject.com/KB/cpp/SOAP_Header_Extension.aspx
	/** Additionally, this snippet can help reduce error by ignoring extra namespace entries in the BODY element **/
	//Regex to match a simple <soap:Body> string or one w/ attributes in it
	Regex reg = new Regex("<soap:Body[^>]*>", RegexOptions.IgnoreCase);
	Match match = reg.Match(soapBodyString);
	int pos1 = match.Index + match.Length;
	int pos2 = soapBodyString.Length-pos1;
	soapBodyString = soapBodyString.Substring(pos1, pos2);
	soapBodyString = match.Value + soapBodyString;
  	
	/** Finally, the C# example using .NET libraries **/	

	private CookieContainer cc;
	
        static void Main(string[] args)
        {
            PortalDataInteropService ps = new PortalDataInteropService();
            ps.Url = "http://www.savvisstation.savvis.com/services";

            if(cc != null)
                cc = new CookieContainer();
			
		/*  Need to initialize a container to keep cookies for sessions */
            ps.CookieContainer = cc;
            
            PortalObjectInterop ticket = new PortalObjectInterop();
            PortalMapItem[] map = new PortalMapItem[4];
            map[0].key = "TICKET_ATTR_TYPE";
            map[0].value = "Network Request";

            map[1].key = "TICKET_ATTR_SUBJECT";
            map[1].value = "test subject here... IGNORE PLEASE";

            map[2].key = "TICKET_ATTR_PRIORITY";
            map[2].value = "3 - Medium";

            map[3].key = "TICKET_ATTR_LOGICAL_SITE_ID";
            map[4].value = "S262804";
            ticket.attributes = map;
            ticket.objectName = "TroubleTicket";
		/*  Create the note  */
            int id = ps.createTicket(ticket);

            PortalObjectInterop ticket = new PortalObjectInterop();
            PortalMapItem[] mapN = new PortalMapItem[4];
            mapN[0].key = "TICKET_NOTE_ATTR_DETAIL";
            mapN[0].value = "Non-html";

            mapN[1].key = "TICKET_NOTE_ATTR_DETAIL_HTML";
            mapN[1].value = "First message to start ...things off...";

            mapN[2].key = "TICKET_NOTE_ATTR_SUBJECT";
            mapN[2].value = "This is the original note ... ";

            mapN[3].key = "TICKET_ATTR_ID";
            mapN[3].value = id ;
           
            ticket.attributes = map;
            ticket.objectName = "Note";
		/*  Add ticket to the newly created note */
            ps.addNoteToTicket(mapN);
          }
 
//PHP Example
 
	

<?php

// Purpose: Get some events from the portal & save them into a stdClass object.

$username = 'savvisStationUsername';

$password = 'your password';

ini_set("soap.wsdl_cache_enabled", "0"); // disabling WSDL cache

try

{

$client = new SoapClient("https://www.savvisstation.savvis.com/services/PortalData?wsdl",array('trace'=>1));

$ns = 'urn:ccc';

$auth = array("username" => new SOAPVar($username, XSD_STRING, null, null, null, $ns),

"password" => new SOAPVar($password, XSD_STRING, null, null, null, $ns));

$headerBody = new SOAPVar($auth, SOAP_ENC_OBJECT);

$header = new SOAPHeader($ns, 'authenticate',$headerBody);

$client->__setSoapHeaders($header);

// Get the events

$output = array();

$output[] = ($client->getEvents(

//soapParam does value, name... not name, value so keep that in mind!

//new soapParam("2","EVENT_PROPERTY_SEVERITY")

));

//Get next most recent 50 events

$i = 0;

while ($i < 5) {

$output[] = $client->getMoreEvents();

$i++;

}

//print_r($output);

$arrayOut = array();



foreach ($output as $poll =>$events) {

foreach ($events as $event=>$object) {

foreach ($object->attributes as $key=>$value){

$eventNumber = $poll . "-" . $event;

$arrayOut[$eventNumber][$value->key] = $value->value;

}

}

}

foreach ($arrayOut as $event=>$params) {

$e = new stdClass();

$e->summary = $params['EVENT_ATTR_SUMMARY'];

$e->deviceName = $params['EVENT_ATTR_CMDBNAME'];

$e->deviceIp = $params['EVENT_ATTR_NODE'];

$e->acknowledged = $params['EVENT_ATTR_ACKNOWLEDGED'];

$e->firstOccurance = $params['EVENT_ATTR_FIRSTOCCURRENCE'];

$e->severity = $params['EVENT_ATTR_SEVERITY'];

print_r($e);



}
}

catch (SoapFault $exception)

{

echo "Last Request: \n";

var_dump ($client->__getLastRequest());

echo "\n\n\nLast Response: \n";

var_dump ($client->__getLastResponse());

echo "<br/>\n";

}

?>