getUpgradeStage

The getUpgradeStage method returns the current overall upgrade or COP file installation stage such as downloading, validating, or in progress.

Request Parameters

None

This result indicates the upgrade stage is validated.

Response Parameters (return element children) Validated

If xsi:nil="true" then there are no remote messages. Otherwise:

error - Boolean, true if an error occurred, false otherwise
info - Boolean
messageKey - A result code such as internal.request.denied.lock if such an error occurred
messageType - The type of error, such as internal.message.error
warning - Boolean, true if this is a warning, false if not
messageParams - Information about the message (there can be more than one messageParam)

result

A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.

upgradeStage

Current stage of the upgrade installation as follows:
upgrade.stage.cancelled - Canceled
upgrade.stage.checksumming - Calculating File Checksum
upgrade.stage.completed - Completed
upgrade.stage.configuring - Configuring (only set if someone is using the
. . . OS Admin or CLI to install an upgrade or COP file)
upgrade.stage.determining.files - Determining Valid Files (only set if
. . . someone is using the OS Admin or CLI to install an upgrade or COP file
upgrade.stage.downloading - Downloading File
upgrade.stage.error - Error (indicates failure)
upgrade.stage.installing - Installing File
upgrade.stage.none - None
upgrade.stage.validating - Validating File
upgrade.stage.validated - File Validated

Example Request and Response

Request Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<SOAP-ENV:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn:getUpgradeStage</wsa:Action>
		<wsa:MessageID>uuid:746e0b0f-d0b6-4e30-ad5e-ba0bc0c13347</wsa:MessageID>
		<wsa:ReplyTo>
			<wsa:Address>http://server/servlet/WSACallBackHandler</wsa:Address>
			<wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType>
		</wsa:ReplyTo>
		<wsa:To>https://server/platform-services/services/UpgradeStageService .UpgradeStageServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<getUpgradeStage xmlns="server_url"/>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://server/servlet/WSACallBackHandler</wsa:To>
		<wsa:MessageID>urn:uuid:371332A0B549A964C21298940705128</wsa:MessageID>
		<wsa:Action>urn:getUpgradeStageResponse</wsa:Action>
		<wsa:RelatesTo>uuid:93816fa1-1614-46e3-b884-5a7919140c4f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getUpgradeStageResponse xmlns:ns="server_url">
			<ns:return xmlns:ax225="server_url/xsd" xmlns:ax226="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax225:UpgradeStageResponse">
				<ax225:remoteMessages xsi:nil="true"/>
				<ax225:result>internal.request.complete</ax225:result>
				<ax225:upgradeStage>upgrade.stage.validated</ax225:upgradeStage>
			</ns:return>
		</ns:getUpgradeStageResponse>
	</soapenv:Body>
</soapenv:Envelope>

This result indicates the upgrade stage is cancelled.

Response Parameters (return element children)