SoftLayer Ticket::addUpdate

From SoftLayer Development Network Wiki

addUpdate is a member of the SoftLayer_Ticket service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 4.2 Optional Headers 5 Parameters 5.1 templateObject 6 Error Handling

Overview

Add an update to a ticket. A ticket update's entry has a maximum length of 4000 characters, so addUpdate() splits the entry property in the templateObject parameter into 3900 character blocks and creates one entry per 3900 character block. Once complete addUpdate() emails the ticket's owner and additional email addresses with an update message if the ticket's notifyUserOnUpdateFlag is set. If the ticket is a Legal or Abuse ticket, then the account's abuse email is also notified when the updates are processed. Finally, addUpdate() returns an array of the newly created ticket updates.

User Access

Users wishing to execute addUpdate service must have the Add / Edit Tickets and View Tickets permissions assigned to their account.

Return Type

addUpdate returns the SoftLayer_Ticket_UpdateArray data type.

Headers

Required Headers

addUpdate requires the following headers:

• authenticate
• SoftLayer_TicketInitParameters

Optional Headers

addUpdate may use the following headers:

• SoftLayer_TicketObjectMask

Parameters

addUpdate takes the following parameters:

templateObject

The update to add to the ticket

• Type: SoftLayer_Ticket_Update

Error Handling

addUpdate throws the following exceptions:

• SoftLayer_Exception_Public

Throw the exception "Unable to create a ticket update longer than 19000 characters." if the entry property in templateObject is over 19000 characters long.

• SoftLayer_Exception_Public

Throw the exception "Unable to add ticket update.." if the API was unable to process the new ticket update.