SoftLayer Network Firewall Template::getObject

From SoftLayer Development Network Wiki

getObject is a member of the SoftLayer_Network_Firewall_Template 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 returns a SoftLayer_Network_Firewall_Template object. You can retrieve all available firewall templates. getAllObjects returns an array of all available SoftLayer_Network_Firewall_Template objects. You can use these templates to generate a SoftLayer Network Firewall Update Request.

@SLDNDocumentation Service See Also SoftLayer_Network_Firewall_Update_Request

User Access

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

Return Type

getObject returns the SoftLayer_Network_Firewall_Template data type.

Headers

Required Headers

getObject requires the following headers:

• authenticate
• SoftLayer_Network_Firewall_TemplateInitParameters

Optional Headers

getObject may use the following headers:

• SoftLayer_Network_Firewall_TemplateObjectMask

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.