SoftLayer Network Security Scanner Request::getObject

From SoftLayer Development Network Wiki

getObject is a member of the SoftLayer_Network_Security_Scanner_Request 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_Network_Security_Scanner_Request object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Security_Scanner_Request service. You can only retrieve requests and reports that are assigned to your SoftLayer account.

User Access

Users wishing to execute getObject service must have the Vulnerability Scanning permission assigned to their account.

Return Type

getObject returns the SoftLayer_Network_Security_Scanner_Request data type.

Headers

Required Headers

getObject requires the following headers:

• authenticate
• SoftLayer_Network_Security_Scanner_RequestInitParameters

Optional Headers

getObject may use the following headers:

• SoftLayer_Network_Security_Scanner_RequestObjectMask

Error Handling

getObject throws the following exceptions:

• SoftLayer_Exception_ObjectNotFound

Throws the error "Unable to find object with id of {id}." when the object for the supplied hardwareId is not found.

• SoftLayer_Exception_Network_Security_Scanner_Request_OpenRequestFound

Throws the error "Only one vulnerability scan may be started at a time." when a trying to create a new request before a previous one for the selected hardware item is finished.

• SoftLayer_Exception_Network_Security_Scanner_Request_ReportNotFound

Throws the error "The selected vulnerability report could not be found." when the report file could not be located.