SoftLayer Hardware Server::getObject

From SoftLayer Development Network Wiki

getObject is a member of the SoftLayer_Hardware_Server service.

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

Overview

getObject retrieves the SoftLayer_Hardware_Server object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve servers from the account that your portal user is assigned to.

User Access

Users wishing to execute getObject service must have the View Hardware permission assigned to their account.

Return Type

getObject returns the SoftLayer_Hardware data type.

Headers

Required Headers

getObject requires the following headers:

• authenticate
• SoftLayer_Hardware_ServerInitParameters

Optional Headers

getObject may use the following headers:

• SoftLayer_Hardware_ServerObjectMask

Error Handling

getObject throws the following exceptions:

• SoftLayer_Exception_ObjectNotFound

Throw the error "Unable to find object with id of {id}." if the given initialization parameter has an invalid id field.

• SoftLayer_Exception_AccessDenied

Throw the error "Access Denied." if the given initialization parameter id field is not the account id of the user making the API call.

• SoftLayer_Exception

Throw the error "Method has not been implemented for this object type." id the method is used.

• SoftLayer_Exception_Public

Throws the exception 'No operating system could be found for this server.' Then the setOperatingSystemPassword method is called to change the password for a server that does not have an operating system setup.