The SOAP Web Service JobNET-200601 allows an application to query for supported job types and submit job instructions for execution.  This Web Service is normally found at the following location: http://127.0.0.1:40001/services/soap/JobNET-200601. The actual host and port will vary for each deployment, however, the path is the normal location that provides the implementation of this service on all instances of Aspera Central. Each deployed instance of Aspera Central may have a different set of job modules installed; this can cause each instance to have different capabilities. You can invoke ListTypes() to determine what job types are available on any given instance of Aspera Central. Once you know the capabilities of the system you can submit instructions for execution by invoking Submit().

This section includes a list of SOAP Service Messages available including their arguments and return values.

This section includes information on the data types that are defined by the XML schema.

The Job.wsdl file demonstrates an example binding to http://127.0.0.1:40001/services/soap/JobNET-200601.  This file comprises the service that is used for code generation by the Web Service framework.  To use this file you must change the soap:address flag, which is located at the bottom of the file.

The data types that are described in this section are used in the XML order description format for Aspera.IScpTransfer Job Types.

The job definitions documention below explains the different job order types.

Additional notes and hints are provided on this page.  These may provide deeper information on certain topics, like Rate Parameters and MTU.

If the application which triggered the transfer is not running on either your Aspera On-Demand instance or the customer's Aspera Server you should use the SOAP Job API.  This API allows you to send a SOAP request to one of the Aspera Nodes to start the transfer.  When working in Azure the approach is to leverage the SOAP API with the REST Node API by issuing Basic Authenticated HTTP requests.  For example, to start the transfer you could use the following cURL command:

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.

Video player

Video

×