On This Page:

Related Pages:

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:

Click here to expand...

Web Service			Type	Description	Req?	Val?
`<sp:OptimizerStopRequest>`
	`<StopRequest>`
		`<Version>?</Version>`		Although this optional parameter has been defined in the API WSDL, only the value `SP_StopOptimizerVersion` (the integer value 1) is valid. In practice, this parameter is not required, and should be omitted when calling the API.
		`<FRU>?</FRU>`		The FRU for which the Optimizer should be stopped.
		`<Date>?</Date>`		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).
		`<Options/>`		N/A and must be set to 0, but is included as a place holder for future enhancements.
	`</StopRequest>`
`</sp:OptimizerStopRequest>`

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:

Click here to expand...

SP_OK (0)
SP_DATE_INVALID (14)
SP_UNIT_INVALID (28)
SP_OUTSIDE_HORIZON (53)
SP_OPTIONS_INVALID (80)
SP_UNIT_NOT_SUPPLIED (261)
SP_OPT_NOT_RUNNING (295)
SP_DATE_IN_PAST (296)

Browser not supported