The following example shows a typical SOAP Job Submission payload where the remote location is an Aspera On-Demand Server running in Azure with Azure Storage.  In order to use this example the SOAP service must be running on Aspera Central 3.3 or higher.  Other useful examples of basic usage are included to help demonstrate normal usage.  It should be noted that the Order needs to be submitted using HTML entities (&lt; and &gt; instead of < and >).  The top part of your XML should be regular XML, however, everything in between needs to be HTML entities instead.

XML Format


Plain Text


It should be noted that the AZURE_STORAGE_ACCOUNT_NAME and AZURE_STORAGE_PRIMARY_ACCESS_KEY must by URL encoded in order for this example to work.


Example Submission

For demonstrations, you could send a request to either http://SERVER_NAME:40001/services/soap/Transfer-201210 or (since 201210 includes all non deprecated features of 200601) with the XML payload of:


This request would yield the following result, which you could then use Reliable Query on to perform your final operations as needed.


Create Destination Directory and Rename

Since Aspera Central 3.3 you can use the SOAP Job API to transfer files to a destination folder that does not exist on a Remote Aspera Server and rename the source files at the destination. This is possible by using the RootPath which allows you to define a base destination directory. The following example Job Order will send the files /srcPath/sourceFile1 and /srcPath/sourceFile2 to a remote base directory located at /path/to/dst where the source files will be stored in different subdirectories and renamed respectively to /f1SubDir/sourceFile1-renamed and /f2SubDir/sourceFile2-renamed.

Video player