SOAP Server API Reference
OL Connect Workflow offers a SOAP Server API Reference allowing jobs to be submitted from a third party application using the SOAP protocol. SOAP is short for Simple Object Access Protocol.
While there are multiple possibilities for solutions using a SOAP server implementation, the SOAP Server API Reference is specifically for submitting jobs from a SOAP client. It implements methods that will allow SOAP clients to submit jobs and get information from OL Connect Workflow executing them.
| Methods, structures | Description |
|---|---|
| GetProcessList | Allows SOAP clients to request the list of available OL Connect Workflow processes, based on their authentication credentials. |
| GetProcessTaskList | Allows a user to remotely request the tasks list of a process. This will be useful with the PostJob method since it needs a TaskIndex. |
| GetSOAPProcessList | Allows users to request the list of OL Connect Workflow processes that contain a SOAP Input plugin with the SOAP action name. This is useful when working with the SubmitJob method since it requires a SOAPActionName. |
| PostJob | Allows users to remotely submit files to OL Connect Workflow by using the Resubmit from here feature, which lets a user specify a starting task index from which the File is to be processed. |
| PostJobInfoStruc | Structure containing any required information to prepare the file for resubmission into a OL Connect Workflow process. |
| SubmitJob |
Allows users to remotely submit files to their OL Connect Workflow from a SOAP client. The SOAP client has the option to wait for a response file from OL Connect Workflow SOAP server. |
|
Structure containing any required information to prepare the file for a valid insertion into a OL Connect Workflow process. |
Note: With the SOAP API reference, new SOAP plugins have been introduced. The old plugin, which could be used as an Input, Action or Output task, was renamed Legacy SOAP Client and has become obsolete.