dataExport

The dataExport method begins an export of the database to an external FTP server.

Request Parameters
args0


The IP address of the FTP server where you plan to send the file.
args1


The port you want to use for FTP (usually 22).
args2


The username for logging in to the FTP server.
args3


The password for logging in to the FTP server.
args4


The remote directory.

This example shows that an error occurred.

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.


dataExportResult


A status code such as error.undetermined.result indicating, if possible, the result of the dataExport.


remoteMessages


If 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
    • 0 - There can be more than one message parameter. This sample has three.
    • 1 - There can be more than one message parameter. This sample has three.
    • 2 - There can be more than one message parameter. This sample has three.

Example Request and Response
Request Response 
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn: dataExport</wsa:Action>
		<wsa:MessageID>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:MessageID>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:To></wsa:To>
	</soapenv:Header>
	<soapenv:Body>
		<dataExport xmlns="http://services.api.platform.vos.cisco.com"/>
		<arg0>FTP_Server</arg0>
		<arg1>22</arg1>
		<arg2>username</arg2>
		<arg3>password</arg3>
		<arg4>/mydatabase</arg4>
	</soapenv:Body>
</soapenv: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://www.w3.org/2005/08/addressing/anonymous</wsa:To>
		<wsa:MessageID>urn:uuid:a0541e26-939a-490b-a3eb-c43ff752d2e0</wsa:MessageID>
		<wsa:Action>urn:dataExportResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:dataExportResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax2106="http://api.platform.vos.cisco.com/xsd" xmlns:ax2105="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax2105:DataExportResponse">
				<ax2105:remoteMessages xsi:type="ax2105:RemoteMessage">
					<ax2106:error>true</ax2106:error>
					<ax2106:info>false</ax2106:info>
					<ax2106:messageKey>internal.request.denied.lock</ax2106:messageKey>
					<ax2106:messageType>internal.message.error</ax2106:messageType>
					<ax2106:warning>false</ax2106:warning>
					<ax2105:messageParams>platform.api.network.address</ax2105:messageParams>
					<ax2105:messageParams>27543@rwerer</ax2105:messageParams>
					<ax2105:messageParams>CreateUffDbImportExportThread-211</ax2105:messageParams>
				</ax2105:remoteMessages>
				<ax2105:result>internal.request.failed</ax2105:result>
				<ax2105:dataExportResult>error.undetermined.result</ax2105:dataExportResult>
			</ns:return>
		</ns:dataExportResponse>
	</soapenv:Body>
</soapenv:Envelope>