SoftLayer Ticket::addAttachedHardware

From SoftLayer Development Network Wiki

addAttachedHardware 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

Attach the given hardware to a SoftLayer ticket. A hardware attachment provides an easy way for SoftLayer's employees to quickly look up your hardware records in the case of hardware-specific issues.

User Access

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

Return Type

addAttachedHardware returns the SoftLayer_Ticket_Attachment_Hardware data type.

Headers

Required Headers

addAttachedHardware requires the following headers:

• authenticate
• SoftLayer_TicketInitParameters

Parameters

addAttachedHardware takes the following parameters:

hardwareId

The internal identifier of the hardware record to attach.

• Type: integer

Error Handling

addAttachedHardware throws the following exceptions:

• SoftLayer_Exception

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

• SoftLayer_Exception

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

• SoftLayer_Exception

Throw the exception "You may not attach this hardware to 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 attach hardware to this ticket." if the API is unable to attach the given hardware to this ticket.

Associated Methods

• SoftLayer_Ticket::removeAttachedHardware