upgradeFilter

The upgradeFilter method returns a list of valid files from the provided list of files. Use this method to locate valid files in a particular SFTP or FTP directory. This call should always be made asynchronously.

Request Parameters

args0

The upgrade type, e.g. "patch"

args1

The file name of an upgrade file (you can have multiple upgrade files as args2, args3, etc.)

args2

The file name of an upgrade file

args3

The file name of an upgrade file

This result indicates that the upgrade filter detected a bad file.

Response Parameters (return element children)

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

result

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

upgradeFiles

Boolean for the nil attribute value, true if the upgrade file does not exist or is bad, or upgrade file exists otherwise

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:upgradeFilter</wsa:Action>
        <wsa:MessageID>uuid:2057d520-f1c9-4821-a6a5-e859c37e9076</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/UpgradeFilterService .UpgradeFilterServiceHttpSoap11Endpoint/</wsa:To>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <upgradeFilter xmlns="server_url">
            <args0>patch</args0>
            <args1>UCSInstall_UCOS_8.6.0.98000-9002.iso</args1>
            <args1>UCSInstall_UCOS_8.6.0.98000-9012.iso</args1>
            <args1>UCSInstall_UCOS_8.6.0.98000-9020.iso</args1>
        </upgradeFilter>
    </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:4F8DCF8A8A3428F84D1297115377730</wsa:MessageID>
		<wsa:Action>urn:upgradeFilterResponse</wsa:Action>
		<wsa:RelatesTo>uuid:473ab189-5161-4ef4-ac30-a8cdad3a9158</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:upgradeFilterResponse xmlns:ns="server_url">
			<ns:return xmlns:ax233="server_url/xsd" xmlns:ax234="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax233:UpgradeFilterResponse">
				<ax233:remoteMessages xsi:type="ax233:RemoteMessage">
					<ax234:error>false</ax234:error>
					<ax234:info>false</ax234:info>
					<ax234:messageKey>warning.upgrade.noupgrades</ax234:messageKey>
					<ax234:messageType>internal.message.warning</ax234:messageType>
					<ax234:warning>true</ax234:warning>
				</ax233:remoteMessages>
				<ax233:result>internal.request.complete.message</ax233:result>
				<ax233:upgradeFiles xsi:nil="true"/>
			</ns:return>
		</ns:upgradeFilterResponse> 
	</soapenv:Body>
</soapenv:Envelope>

This result indicates that the upgrade filter was successful.