2022.2

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 PlanetPress Workflow executing them.
Methods, structures Description
"GetProcessList" below Allows SOAP clients to request the list of available PlanetPress Workflow processes, based on their authentication credentials.
"GetProcessTaskList" on
the facing page
Allows a user to remotely request the tasks list of a process. This will be useful with the PostJob method since it needs a TaskIn-
dex.
"GetSOAPProcessList"
on page126
Allows users to request the list of PlanetPress 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" on page126
Allows users to remotely submit files to PlanetPress 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" on
page127
Structure containing any required information to prepare the file for resubmission into a PlanetPress Workflow process.
"SubmitJob" on page128
Allows users to remotely submit files to their PlanetPress Workflow from a SOAP client. The SOAP client has the option to
wait for a response file from PlanetPress Workflow SOAP server.
"SubmitJobInfStruc" on
page129
Structure containing any required information to prepare the file for a valid insertion into a PlanetPress 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.
GetProcessList
The GetProcessList function allows SOAP clients to request the list of available PlanetPress Workflow
processes, based on their authentication credentials.
Syntax
GetProcessList (user name, Password) : GetProcessListResult
Parameters
l
user name: String containing the user name.
l
Password: String containing the password. This is case sensitive.
Return Value
l
GetProcessListResult: Structure containing the following information:
l
Success: Integer indicating the system-defined Success/Error level of the operation. A res-
ult of 0 means that the operation was successful.
Page 124