14.1 Stop Optimizer SOAP API
- Billy Sewell (Unlicensed)
- Jason Andrew
The sp:OptimizerStopRequest API method can be used to stop a running Optimizer process.
Description
Stops a running Optimizer (i.e. is in the running state) for a given FRU on a given date. The Optimizer can also be stopped while in the waiting or re-allocating states; an Optimizer in the de-allocating state (i.e. during the post Optimizer de-allocation operation) will stopped as soon as it has finished de-allocating.
The sp:OptimizerStopRequest API method returns immediately without waiting for the Optimizer to reach the stopped state.
Definition
The definition of this API is:
Web Service | Type | Description | Req? | Val? | ||
|
|
|
|
| ||
|
|
|
|
|
| |
|
|
| Although this optional parameter has been defined in the API WSDL, only the value
|
|
| |
|
|
| The FRU for which the Optimizer should be stopped. |
|
| |
|
|
| The date for the running Optimizer. The actual Optimizer that is stopped will depend on which Optimizer horizon the supplied Date falls within (see 16.1). |
|
| |
|
|
| N/A and must be set to 0, but is included as a place holder for future enhancements. |
|
| |
|
|
|
|
|
| |
|
|
|
|
| ||
Return Structure
The API returns the standard return structure.
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are: