Package com.softlayer.api.service
Class Ticket
java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.Ticket
@ApiType("SoftLayer_Ticket") public class Ticket extends Entity
The SoftLayer_Ticket data type models a single SoftLayer customer support or notification ticket. Each ticket object contains references to it's updates, the user it's assigned to, the SoftLayer department and employee that it's assigned to, and any hardware objects or attached files associated with the ticket. Tickets are described in further detail on the [[SoftLayer_Ticket]] service page.
To create a support ticket execute the [[SoftLayer_Ticket::createStandardTicket|createStandardTicket]] or [[SoftLayer_Ticket::createAdministrativeTicket|createAdministrativeTicket]] methods in the SoftLayer_Ticket service. To create an upgrade ticket for the SoftLayer sales group execute the [[SoftLayer_Ticket::createUpgradeTicket|createUpgradeTicket]].
To create a support ticket execute the [[SoftLayer_Ticket::createStandardTicket|createStandardTicket]] or [[SoftLayer_Ticket::createAdministrativeTicket|createAdministrativeTicket]] methods in the SoftLayer_Ticket service. To create an upgrade ticket for the SoftLayer sales group execute the [[SoftLayer_Ticket::createUpgradeTicket|createUpgradeTicket]].
- See Also:
- SoftLayer_Ticket
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Ticket.Mask
static interface
Ticket.Service
Tickets are SoftLayer's primary way to keep in touch with its customers.static interface
Ticket.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Account
account
The SoftLayer customer account associated with a ticket.protected Long
accountId
An internal identifier of the SoftLayer customer account that a ticket is associated with.protected boolean
accountIdSpecified
protected Long
assignedAgentCount
A count ofprotected List<Customer>
assignedAgents
protected Customer
assignedUser
The portal user that a ticket is assigned to.protected Long
assignedUserId
An internal identifier of the portal user that a ticket is assigned to.protected boolean
assignedUserIdSpecified
protected Long
attachedAdditionalEmailCount
A count of the list of additional emails to notify when a ticket update is made.protected List<AdditionalEmail>
attachedAdditionalEmails
The list of additional emails to notify when a ticket update is made.protected Long
attachedDedicatedHostCount
A count of the Dedicated Hosts associated with a ticket.protected List<DedicatedHost>
attachedDedicatedHosts
The Dedicated Hosts associated with a ticket.protected Long
attachedFileCount
A count of the files attached to a ticket.protected List<File>
attachedFiles
The files attached to a ticket.protected List<Hardware>
attachedHardware
The hardware associated with a ticket.protected Long
attachedHardwareCount
protected Long
attachedResourceCount
A count ofprotected List<Attachment>
attachedResources
protected Long
attachedVirtualGuestCount
A count of the virtual guests associated with a ticket.protected List<Guest>
attachedVirtualGuests
The virtual guests associated with a ticket.protected Boolean
awaitingUserResponseFlag
Ticket is waiting on a response from a customer flag.protected Boolean
billableFlag
Whether a ticket has a one-time charge associated with it.protected boolean
billableFlagSpecified
protected Boolean
bnppSupportedFlag
A ticket's associated BNPP compliant recordprotected Long
bnppSupportedLocationId
protected boolean
bnppSupportedLocationIdSpecified
protected Request
cancellationRequest
A service cancellation request.protected Boolean
changeOwnerFlag
protected boolean
changeOwnerFlagSpecified
protected GregorianCalendar
createDate
The date that a ticket was created.protected boolean
createDateSpecified
protected Long
employeeAttachmentCount
A count ofprotected List<Employee>
employeeAttachments
protected Boolean
euSupportedFlag
A ticket's associated EU compliant recordprotected Long
euSupportedLocationId
protected boolean
euSupportedLocationIdSpecified
protected String
finalComments
Feedback left by a portal or API user on their experiences in a ticket.protected boolean
finalCommentsSpecified
protected Attachment
firstAttachedResource
The first physical or virtual server attached to a ticket.protected Update
firstUpdate
The first update made to a ticket.protected Group
group
The SoftLayer department that a ticket is assigned to.protected Long
groupId
The internal identifier of the SoftLayer department that a ticket is assigned to.protected boolean
groupIdSpecified
protected Long
id
A ticket's internal identifier.protected boolean
idSpecified
protected Long
invoiceItemCount
A count of the invoice items associated with a ticket.protected List<Item>
invoiceItems
The invoice items associated with a ticket.protected Activity
lastActivity
protected GregorianCalendar
lastEditDate
The date that a ticket was last modified.protected boolean
lastEditDateSpecified
protected Interface
lastEditor
protected String
lastEditType
The type of user who last edited or updated a ticket.protected boolean
lastEditTypeSpecified
protected GregorianCalendar
lastResponseDate
The date that the last ticket update was madeprotected boolean
lastResponseDateSpecified
protected Update
lastUpdate
The last update made to a ticket.protected Location
location
A ticket's associated location within the SoftLayer location hierarchy.protected Long
locationId
The internal identifier of the location associated with a ticket.protected boolean
locationIdSpecified
protected GregorianCalendar
modifyDate
The date that a ticket was last updated.protected boolean
modifyDateSpecified
protected Boolean
newUpdatesFlag
True if there are new, unread updates to this ticket for the current user, False otherwise.protected Boolean
notifyUserOnUpdateFlag
Whether or not the user who owns a ticket is notified via email when a ticket is updated.protected boolean
notifyUserOnUpdateFlagSpecified
protected String
originatingIpAddress
The IP address of the user who opened a ticket.protected boolean
originatingIpAddressSpecified
protected Long
priority
protected boolean
prioritySpecified
protected Long
responsibleBrandId
protected boolean
responsibleBrandIdSpecified
protected Long
scheduledActionCount
A count ofprotected List<Transaction>
scheduledActions
protected Long
serverAdministrationBillingAmount
The amount of money in US Dollars ($USD) that a ticket has charged to an account.protected boolean
serverAdministrationBillingAmountSpecified
protected Invoice
serverAdministrationBillingInvoice
The invoice associated with a ticket.protected Long
serverAdministrationBillingInvoiceId
The internal identifier of the invoice associated with a ticket's administrative charge.protected boolean
serverAdministrationBillingInvoiceIdSpecified
protected Long
serverAdministrationFlag
Whether a ticket is a standard or an administrative support ticket.protected boolean
serverAdministrationFlagSpecified
protected Invoice
serverAdministrationRefundInvoice
The refund invoice associated with a ticket.protected Long
serverAdministrationRefundInvoiceId
The internal identifier of the refund invoice associated with a ticket.protected boolean
serverAdministrationRefundInvoiceIdSpecified
protected Provider
serviceProvider
protected Long
serviceProviderId
protected boolean
serviceProviderIdSpecified
protected String
serviceProviderResourceId
A ticket's internal identifier at its service provider.protected boolean
serviceProviderResourceIdSpecified
protected List<State>
state
protected Long
stateCount
A count ofprotected Status
status
A ticket's status.protected Long
statusId
A ticket status' internal identifier.protected boolean
statusIdSpecified
protected Subject
subject
A ticket's subject.protected Long
subjectId
An internal identifier of the pre-set subject that a ticket is associated with.protected boolean
subjectIdSpecified
protected Long
tagReferenceCount
A count ofprotected List<Reference>
tagReferences
protected String
title
A ticket's title.protected boolean
titleSpecified
protected Long
totalUpdateCount
protected boolean
totalUpdateCountSpecified
protected Long
updateCount
A count of a ticket's updates.protected Boolean
updateRatingFlag
Whether employees' updates of this ticket could be rated by customerprotected List<Update>
updates
A ticket's updates.protected Boolean
userEditableFlag
Whether a user is able to update a ticket.protected boolean
userEditableFlagSpecified
-
Constructor Summary
Constructors Constructor Description Ticket()
-
Method Summary
-
Field Details
-
account
The SoftLayer customer account associated with a ticket. -
assignedAgents
-
assignedUser
The portal user that a ticket is assigned to. -
attachedAdditionalEmails
The list of additional emails to notify when a ticket update is made. -
attachedDedicatedHosts
The Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts. -
attachedFiles
The files attached to a ticket. -
attachedHardware
The hardware associated with a ticket. This is used in cases where a ticket is directly associated with one or more pieces of hardware. -
attachedHardwareCount
-
attachedResources
-
attachedVirtualGuests
The virtual guests associated with a ticket. This is used in cases where a ticket is directly associated with one or more virtualized guests installations or Virtual Servers. -
awaitingUserResponseFlag
Ticket is waiting on a response from a customer flag. -
bnppSupportedFlag
A ticket's associated BNPP compliant record -
cancellationRequest
A service cancellation request. -
employeeAttachments
-
euSupportedFlag
A ticket's associated EU compliant record -
firstAttachedResource
The first physical or virtual server attached to a ticket. -
firstUpdate
The first update made to a ticket. This is typically the contents of a ticket when it's created. -
group
The SoftLayer department that a ticket is assigned to. -
invoiceItems
The invoice items associated with a ticket. Ticket based invoice items only exist when a ticket incurs a fee that has been invoiced. -
lastActivity
-
lastEditor
-
lastUpdate
The last update made to a ticket. -
location
A ticket's associated location within the SoftLayer location hierarchy. -
newUpdatesFlag
True if there are new, unread updates to this ticket for the current user, False otherwise. -
scheduledActions
-
serverAdministrationBillingInvoice
The invoice associated with a ticket. Only tickets with an associated administrative charge have an invoice. -
serverAdministrationRefundInvoice
The refund invoice associated with a ticket. Only tickets with a refund applied in them have an associated refund invoice. -
serviceProvider
-
state
-
status
A ticket's status. -
subject
A ticket's subject. Only standard support tickets have an associated subject. A standard support ticket's title corresponds with it's subject's name. -
tagReferences
-
updateRatingFlag
Whether employees' updates of this ticket could be rated by customer -
updates
A ticket's updates. -
accountId
An internal identifier of the SoftLayer customer account that a ticket is associated with. -
accountIdSpecified
protected boolean accountIdSpecified -
assignedUserId
An internal identifier of the portal user that a ticket is assigned to. -
assignedUserIdSpecified
protected boolean assignedUserIdSpecified -
billableFlag
Whether a ticket has a one-time charge associated with it. Standard tickets are free while administrative tickets typically cost $3 USD. -
billableFlagSpecified
protected boolean billableFlagSpecified -
bnppSupportedLocationId
-
bnppSupportedLocationIdSpecified
protected boolean bnppSupportedLocationIdSpecified -
changeOwnerFlag
-
changeOwnerFlagSpecified
protected boolean changeOwnerFlagSpecified -
createDate
The date that a ticket was created. -
createDateSpecified
protected boolean createDateSpecified -
euSupportedLocationId
-
euSupportedLocationIdSpecified
protected boolean euSupportedLocationIdSpecified -
finalComments
Feedback left by a portal or API user on their experiences in a ticket. Final comments may be created after a ticket is closed. -
finalCommentsSpecified
protected boolean finalCommentsSpecified -
groupId
The internal identifier of the SoftLayer department that a ticket is assigned to. -
groupIdSpecified
protected boolean groupIdSpecified -
id
A ticket's internal identifier. Each ticket is defined by a unique identifier. -
idSpecified
protected boolean idSpecified -
lastEditDate
The date that a ticket was last modified. A modification does not necessarily mean that an update was added. -
lastEditDateSpecified
protected boolean lastEditDateSpecified -
lastEditType
The type of user who last edited or updated a ticket. This is either "EMPLOYEE" or "USER". -
lastEditTypeSpecified
protected boolean lastEditTypeSpecified -
lastResponseDate
The date that the last ticket update was made -
lastResponseDateSpecified
protected boolean lastResponseDateSpecified -
locationId
The internal identifier of the location associated with a ticket. -
locationIdSpecified
protected boolean locationIdSpecified -
modifyDate
The date that a ticket was last updated. -
modifyDateSpecified
protected boolean modifyDateSpecified -
notifyUserOnUpdateFlag
Whether or not the user who owns a ticket is notified via email when a ticket is updated. -
notifyUserOnUpdateFlagSpecified
protected boolean notifyUserOnUpdateFlagSpecified -
originatingIpAddress
The IP address of the user who opened a ticket. -
originatingIpAddressSpecified
protected boolean originatingIpAddressSpecified -
priority
-
prioritySpecified
protected boolean prioritySpecified -
responsibleBrandId
-
responsibleBrandIdSpecified
protected boolean responsibleBrandIdSpecified -
serverAdministrationBillingAmount
The amount of money in US Dollars ($USD) that a ticket has charged to an account. A ticket's administrative billing amount is a one time charge and only applies to administrative support tickets. -
serverAdministrationBillingAmountSpecified
protected boolean serverAdministrationBillingAmountSpecified -
serverAdministrationBillingInvoiceId
The internal identifier of the invoice associated with a ticket's administrative charge. Only tickets with an administrative charge have an associated invoice. -
serverAdministrationBillingInvoiceIdSpecified
protected boolean serverAdministrationBillingInvoiceIdSpecified -
serverAdministrationFlag
Whether a ticket is a standard or an administrative support ticket. Administrative support tickets typically incur a $3 USD charge. -
serverAdministrationFlagSpecified
protected boolean serverAdministrationFlagSpecified -
serverAdministrationRefundInvoiceId
The internal identifier of the refund invoice associated with a ticket. Only tickets with an account refund associated with them have an associated refund invoice. -
serverAdministrationRefundInvoiceIdSpecified
protected boolean serverAdministrationRefundInvoiceIdSpecified -
serviceProviderId
-
serviceProviderIdSpecified
protected boolean serviceProviderIdSpecified -
serviceProviderResourceId
A ticket's internal identifier at its service provider. Each ticket is defined by a unique identifier. -
serviceProviderResourceIdSpecified
protected boolean serviceProviderResourceIdSpecified -
statusId
A ticket status' internal identifier. -
statusIdSpecified
protected boolean statusIdSpecified -
subjectId
An internal identifier of the pre-set subject that a ticket is associated with. Standard support tickets have a subject set while administrative tickets have a null subject. A standard support ticket's title is the name of it's associated subject. -
subjectIdSpecified
protected boolean subjectIdSpecified -
title
A ticket's title. This is typically a brief summary of the issue described in the ticket. -
titleSpecified
protected boolean titleSpecified -
totalUpdateCount
-
totalUpdateCountSpecified
protected boolean totalUpdateCountSpecified -
userEditableFlag
Whether a user is able to update a ticket. -
userEditableFlagSpecified
protected boolean userEditableFlagSpecified -
assignedAgentCount
A count of -
attachedAdditionalEmailCount
A count of the list of additional emails to notify when a ticket update is made. -
attachedDedicatedHostCount
A count of the Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts. -
attachedFileCount
A count of the files attached to a ticket. -
attachedResourceCount
A count of -
attachedVirtualGuestCount
A count of the virtual guests associated with a ticket. This is used in cases where a ticket is directly associated with one or more virtualized guests installations or Virtual Servers. -
employeeAttachmentCount
A count of -
invoiceItemCount
A count of the invoice items associated with a ticket. Ticket based invoice items only exist when a ticket incurs a fee that has been invoiced. -
scheduledActionCount
A count of -
stateCount
A count of -
tagReferenceCount
A count of -
updateCount
A count of a ticket's updates.
-
-
Constructor Details
-
Ticket
public Ticket()
-
-
Method Details
-
getAccount
-
setAccount
-
getAssignedAgents
-
getAssignedUser
-
setAssignedUser
-
getAttachedAdditionalEmails
-
getAttachedDedicatedHosts
-
getAttachedFiles
-
getAttachedHardware
-
getAttachedHardwareCount
-
setAttachedHardwareCount
-
getAttachedResources
-
getAttachedVirtualGuests
-
getAwaitingUserResponseFlag
-
setAwaitingUserResponseFlag
-
getBnppSupportedFlag
-
setBnppSupportedFlag
-
getCancellationRequest
-
setCancellationRequest
-
getEmployeeAttachments
-
getEuSupportedFlag
-
setEuSupportedFlag
-
getFirstAttachedResource
-
setFirstAttachedResource
-
getFirstUpdate
-
setFirstUpdate
-
getGroup
-
setGroup
-
getInvoiceItems
-
getLastActivity
-
setLastActivity
-
getLastEditor
-
setLastEditor
-
getLastUpdate
-
setLastUpdate
-
getLocation
-
setLocation
-
getNewUpdatesFlag
-
setNewUpdatesFlag
-
getScheduledActions
-
getServerAdministrationBillingInvoice
-
setServerAdministrationBillingInvoice
-
getServerAdministrationRefundInvoice
-
setServerAdministrationRefundInvoice
-
getServiceProvider
-
setServiceProvider
-
getState
-
getStatus
-
setStatus
-
getSubject
-
setSubject
-
getTagReferences
-
getUpdateRatingFlag
-
setUpdateRatingFlag
-
getUpdates
-
getAccountId
-
setAccountId
-
isAccountIdSpecified
public boolean isAccountIdSpecified() -
unsetAccountId
public void unsetAccountId() -
getAssignedUserId
-
setAssignedUserId
-
isAssignedUserIdSpecified
public boolean isAssignedUserIdSpecified() -
unsetAssignedUserId
public void unsetAssignedUserId() -
getBillableFlag
-
setBillableFlag
-
isBillableFlagSpecified
public boolean isBillableFlagSpecified() -
unsetBillableFlag
public void unsetBillableFlag() -
getBnppSupportedLocationId
-
setBnppSupportedLocationId
-
isBnppSupportedLocationIdSpecified
public boolean isBnppSupportedLocationIdSpecified() -
unsetBnppSupportedLocationId
public void unsetBnppSupportedLocationId() -
getChangeOwnerFlag
-
setChangeOwnerFlag
-
isChangeOwnerFlagSpecified
public boolean isChangeOwnerFlagSpecified() -
unsetChangeOwnerFlag
public void unsetChangeOwnerFlag() -
getCreateDate
-
setCreateDate
-
isCreateDateSpecified
public boolean isCreateDateSpecified() -
unsetCreateDate
public void unsetCreateDate() -
getEuSupportedLocationId
-
setEuSupportedLocationId
-
isEuSupportedLocationIdSpecified
public boolean isEuSupportedLocationIdSpecified() -
unsetEuSupportedLocationId
public void unsetEuSupportedLocationId() -
getFinalComments
-
setFinalComments
-
isFinalCommentsSpecified
public boolean isFinalCommentsSpecified() -
unsetFinalComments
public void unsetFinalComments() -
getGroupId
-
setGroupId
-
isGroupIdSpecified
public boolean isGroupIdSpecified() -
unsetGroupId
public void unsetGroupId() -
getId
-
setId
-
isIdSpecified
public boolean isIdSpecified() -
unsetId
public void unsetId() -
getLastEditDate
-
setLastEditDate
-
isLastEditDateSpecified
public boolean isLastEditDateSpecified() -
unsetLastEditDate
public void unsetLastEditDate() -
getLastEditType
-
setLastEditType
-
isLastEditTypeSpecified
public boolean isLastEditTypeSpecified() -
unsetLastEditType
public void unsetLastEditType() -
getLastResponseDate
-
setLastResponseDate
-
isLastResponseDateSpecified
public boolean isLastResponseDateSpecified() -
unsetLastResponseDate
public void unsetLastResponseDate() -
getLocationId
-
setLocationId
-
isLocationIdSpecified
public boolean isLocationIdSpecified() -
unsetLocationId
public void unsetLocationId() -
getModifyDate
-
setModifyDate
-
isModifyDateSpecified
public boolean isModifyDateSpecified() -
unsetModifyDate
public void unsetModifyDate() -
getNotifyUserOnUpdateFlag
-
setNotifyUserOnUpdateFlag
-
isNotifyUserOnUpdateFlagSpecified
public boolean isNotifyUserOnUpdateFlagSpecified() -
unsetNotifyUserOnUpdateFlag
public void unsetNotifyUserOnUpdateFlag() -
getOriginatingIpAddress
-
setOriginatingIpAddress
-
isOriginatingIpAddressSpecified
public boolean isOriginatingIpAddressSpecified() -
unsetOriginatingIpAddress
public void unsetOriginatingIpAddress() -
getPriority
-
setPriority
-
isPrioritySpecified
public boolean isPrioritySpecified() -
unsetPriority
public void unsetPriority() -
getResponsibleBrandId
-
setResponsibleBrandId
-
isResponsibleBrandIdSpecified
public boolean isResponsibleBrandIdSpecified() -
unsetResponsibleBrandId
public void unsetResponsibleBrandId() -
getServerAdministrationBillingAmount
-
setServerAdministrationBillingAmount
-
isServerAdministrationBillingAmountSpecified
public boolean isServerAdministrationBillingAmountSpecified() -
unsetServerAdministrationBillingAmount
public void unsetServerAdministrationBillingAmount() -
getServerAdministrationBillingInvoiceId
-
setServerAdministrationBillingInvoiceId
-
isServerAdministrationBillingInvoiceIdSpecified
public boolean isServerAdministrationBillingInvoiceIdSpecified() -
unsetServerAdministrationBillingInvoiceId
public void unsetServerAdministrationBillingInvoiceId() -
getServerAdministrationFlag
-
setServerAdministrationFlag
-
isServerAdministrationFlagSpecified
public boolean isServerAdministrationFlagSpecified() -
unsetServerAdministrationFlag
public void unsetServerAdministrationFlag() -
getServerAdministrationRefundInvoiceId
-
setServerAdministrationRefundInvoiceId
-
isServerAdministrationRefundInvoiceIdSpecified
public boolean isServerAdministrationRefundInvoiceIdSpecified() -
unsetServerAdministrationRefundInvoiceId
public void unsetServerAdministrationRefundInvoiceId() -
getServiceProviderId
-
setServiceProviderId
-
isServiceProviderIdSpecified
public boolean isServiceProviderIdSpecified() -
unsetServiceProviderId
public void unsetServiceProviderId() -
getServiceProviderResourceId
-
setServiceProviderResourceId
-
isServiceProviderResourceIdSpecified
public boolean isServiceProviderResourceIdSpecified() -
unsetServiceProviderResourceId
public void unsetServiceProviderResourceId() -
getStatusId
-
setStatusId
-
isStatusIdSpecified
public boolean isStatusIdSpecified() -
unsetStatusId
public void unsetStatusId() -
getSubjectId
-
setSubjectId
-
isSubjectIdSpecified
public boolean isSubjectIdSpecified() -
unsetSubjectId
public void unsetSubjectId() -
getTitle
-
setTitle
-
isTitleSpecified
public boolean isTitleSpecified() -
unsetTitle
public void unsetTitle() -
getTotalUpdateCount
-
setTotalUpdateCount
-
isTotalUpdateCountSpecified
public boolean isTotalUpdateCountSpecified() -
unsetTotalUpdateCount
public void unsetTotalUpdateCount() -
getUserEditableFlag
-
setUserEditableFlag
-
isUserEditableFlagSpecified
public boolean isUserEditableFlagSpecified() -
unsetUserEditableFlag
public void unsetUserEditableFlag() -
getAssignedAgentCount
-
setAssignedAgentCount
-
getAttachedAdditionalEmailCount
-
setAttachedAdditionalEmailCount
-
getAttachedDedicatedHostCount
-
setAttachedDedicatedHostCount
-
getAttachedFileCount
-
setAttachedFileCount
-
getAttachedResourceCount
-
setAttachedResourceCount
-
getAttachedVirtualGuestCount
-
setAttachedVirtualGuestCount
-
getEmployeeAttachmentCount
-
setEmployeeAttachmentCount
-
getInvoiceItemCount
-
setInvoiceItemCount
-
getScheduledActionCount
-
setScheduledActionCount
-
getStateCount
-
setStateCount
-
getTagReferenceCount
-
setTagReferenceCount
-
getUpdateCount
-
setUpdateCount
-
asService
-
service
-
service
-