SoftLayer Ticket::edit

From SoftLayer Development Network Wiki

Jump to: navigation, search

edit is a member of the SoftLayer_Ticket service.

Contents

Overview

Edit a SoftLayer ticket. The edit method is two-fold. You may either edit a ticket itself, add an update to a ticket, attach up to two files to a ticket, or perform all of these tasks. The SoftLayer API ignores changes made to the userEditableFlag and accountId properties. You may not assign a ticket to a user that your API account does not have access to. You may not enter a custom title for standard support tickets, buy may do so when editing an administrative ticket. Finally, you may not close a ticket using this method. Please contact SoftLayer if you need a ticket closed.

If you need to only add an update to a ticket then please use the addUpdate method in this service. Likewise if you need to only attach a file to a ticket then use the addAttachedFile method. The edit method exists as a convenience if you need to perform all these tasks at once.

User Access

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

Return Type

edit returns the SoftLayer_Ticket data type.

Headers

Required Headers

edit requires the following headers:

Parameters

edit takes the following parameters:

templateObject

A skeleton SoftLayer_Ticket object containing the data of the ticket you wish to submit.


contents

The contents of the first update of the ticket. This is typically the ticket's problem description.

  • Type: string


attachedFiles

An array of no more than two files to attach to your ticket.

Error Handling

edit throws the following exceptions:

  • SoftLayer_Exception
Throw the exception "Please provide a subject when creating a standard support ticket." If the $templateObject parameter does not have a subjectId set. See SoftLayer_Ticket_Subject for more information.
  • SoftLayer_Exception
Throw the exception "Please provide ticket update contents." if no update contents are provided to the method.
  • SoftLayer_Exception
Throw the exception "You may not attach more than two files when updating a ticket." If the attachedFiles parameter contains more than two files.

Associated Methods

Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Ticket::edit"
Personal tools