SoftLayer Ticket::removeAttachedHardware

From SoftLayer Development Network Wiki

removeAttachedHardware is a member of the SoftLayer_Ticket service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 5 Parameters 5.1 hardwareId 6 Error Handling 7 Associated Methods

Overview

detach the given hardware from a SoftLayer ticket. Removing a hardware attachment may delay ticket processing time if the hardware removed is relevant to the ticket's issue. Return a boolean true upon successful hardware detachment.

User Access

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

Return Type

removeAttachedHardware returns the boolean data type.

Headers

Required Headers

removeAttachedHardware requires the following headers:

• authenticate
• SoftLayer_TicketInitParameters

Parameters

removeAttachedHardware takes the following parameters:

hardwareId

The internal identifier of the hardware record to detach

• Type: integer

Error Handling

removeAttachedHardware throws the following exceptions:

• SoftLayer_Exception

Throw the exception "Unable to detath null hardware from this ticket." if no hardware identifier is provided.

• SoftLayer_Exception

Throw the exception "This hardware is not attached to this ticket." if the given hardware is not attached to this ticket.

• SoftLayer_Exception

Throw the exception "You may not detach this hardware from this ticket." if the user making the API call does not have permission to use the given hardware.

• SoftLayer_Exception

Throw the exception "Unable to detach hardware from this ticket." if the API is unable to detach the given hardware from this ticket.

Associated Methods

• SoftLayer_Ticket::addAttachedHardware