2019.2

Table Of Contents
SOAP Server API Reference
PlanetPress 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
PlanetPress Workflow executing them.
Methods, structures Description
"GetProcessList" on
the next page
Allows SOAP clients to request the list of available PlanetPress
Workflow processes, based on their authentication credentials.
"GetProcessTaskList"
on page153
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"
on page153
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154 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
page156
Structure containing any required information to prepare the file
for resubmission into a PlanetPress Workflow process.
"SubmitJob" on
page156
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
page158
Structure containing any required information to prepare the file
for a valid insertion into a PlanetPress Workflow process.
Page 151