upgradeFilter
The upgradeFilter method returns a list of valid upgrade files from the provided list of files. Use this method to determine if there are valid upgrade files in a list of files prepared and sent by the client application. This call should always be made asynchronously.
Request Parameters
upgradeFilter
args0- upgrade type
args1 - filename of upgrade file 1
args1 - filename of upgrade file 2
args1 - filename of upgrade file 3
args1 - filename of upgrade file 1
args1 - filename of upgrade file 2
args1 - filename of upgrade file 3
This result indicates that the upgrade filter detected a bad file.
Response Parameters (return element children)
remoteMessages
error - Boolean: true, message is an error message, false it is not
info - Boolean: true,message is an informational message, false it is not
messageKey - identifies info, warning or error message
messageType - identifies messagekey as info, warning, or error
warning - Boolean: true,message is a warning message, false it is not
messageParams - identifies messagekey parameters
info - Boolean: true,message is an informational message, false it is not
messageKey - identifies info, warning or error message
messageType - identifies messagekey as info, warning, or error
warning - Boolean: true,message is a warning message, false it is not
messageParams - identifies messagekey parameters
result
A result code such as internal.request.complete that describes the result. See Error Codes in the
Developer's Guide for details.
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> <wsa:Action xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> urn:upgradeFilter</wsa:Action> <wsa:MessageID xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> uuid:2057d520-f1c9-4821-a6a5-e859c37e9076</wsa:MessageID> <wsa:ReplyTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> <wsa:Address>http://server/servlet/WSACallBackHandler </wsa:Address> <wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType> </wsa:ReplyTo> <wsa:To xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> 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:upgradeFilterResponsev </soapenv:Body> </soapenv:Envelope>
This result indicates that the upgrade filter was successful.
Response Parameters (return element children)
result
A result code such as internal.request.complete that describes the result. See Error Codes in the
Developer's Guide for details.
Developer's Guide for details.
upgradeFiles
The upgrade file name
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> <wsa:Action xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> urn:upgradeFilter</wsa:Action> <wsa:MessageID xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> uuid:2057d520-f1c9-4821-a6a5-e859c37e9076</wsa:MessageID> <wsa:ReplyTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> <wsa:Address>http://server/servlet/WSACallBackHandler </wsa:Address> <wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType> </wsa:ReplyTo> <wsa:To xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> 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:4F8DCF8A8A3428F84D1297115500226</wsa:MessageID> <wsa:Action>urn:upgradeFilterResponse</wsa:Action> <wsa:RelatesTo>uuid:9140d100-77c3-4671-8b42-4f9ad62e5fa5</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:result>internal.request.complete</ax233:result> <ax233:upgradeFiles>UCSInstall_UCOS_8.6.0.96000-9007.iso</ax233:upgradeFiles> </ns:return> </ns:upgradeFilterResponse> </soapenv:Body> </soapenv:Envelope>