Web Service

Using the POST method to interface to a defined mapping.

The HTTP POST must have, for most cases, as Content-Type: multipart/form-data.
- A Content-Disposition must be present for each part.
- Parts can be added
  - for a data-file: a (UTF-8 encoded) filename must be specified in the Content-Disposition.
  - for a parameter: a name must be specified in the Content-Disposition.
- Currently supported encodings: no encoding and base64.
Typical use case is to associate a mapping with submitting a task with a specified ticket on the posted data.
- Example: posting data to
  http://myAEServer:configuredPort/ws/PathAsDefinedInMyFavoriteMapping
  might result in launching the workflow as specified in the mapping, on the posted data
- The task is launched on a data file as found via the Content-Disposition.
- The Job context to be used for the task, can be specified by adding a parameter; values must be UTF-8 encoded;
  - jobid
  - jobname
  - orderid
- In case of a WorkFlow task, additional parameters found in the POST, are used to set the value of existing WorkFlow parameters.
- The uploaded data
  - is moved to the folder of the job if a jobcontext is specified.
  - is deleted when the task has ran successfully and no jobcontext was specified.
  - is kept on a folder on the share \\myAEServer\AutomationEngineTmpFolder when the task did not ran successfully and no jobcontext was specified.
There is a difference between a succesfull POST and a successfull triggering of the defined mapping.
Therefor, always examine the returned data of the POST; it can contain error messages.
Example:
```
<?xml version="1.0" encoding="UTF-8" ?>
<message>
 <error>
  <code>-110</code>
  <msg>Problem loading ticket: anUnexistingWF</msg>
 </error>
</message>
```
in case of a synchronous Access Point, no XML doc is returned but the result of the Workflow is returned if that is calculated within the specified timeout
- the file on the OK pin in case of 1 file
- a MIME package multipart/mixed in case there were multiple files on the OK pins

Using the GET method:

to list all the defined mappings: /list

Authentication in the case of an AE SaaS

For an AE in a SaaS environment, the secure https protocol (without port) is to be used and authentication is always required.
The following authentication schemes are supported:

Basic Authentication : using a username-password combination of an internal-AE or LDAP user
Token Authentication : include a header AutomationEngine-Token with a valid token

HTTP request examples using curl

Take care to use correct quoting, if needed, for the arguments depending of the platform used (Windows/Unix).
(Below examples refer to an AE host "loppem" with default port 4415, and for SaaS, to a host with public name "AEin.theDC.com")

Doing a HTTP GET setting the jobcontext and setting the value for a workflow parameter

curl --get --data "orderid=2016_45588" --data "wfparam1=89" http://loppem:4415/ws/accesspoint14

Doing a multipart/form-data HTTP POST uploading a file and setting the jobcontext and setting the value for a workflow parameter

curl --form "fileupload=@/Users/pipo/design1.pdf;filename=design1.pdf" --form "orderid=2016_45588" --form "wfparam1=89" http://loppem:4415/ws/accesspoint14

Doing an application/x-www-form-urlencoded HTTP POST setting the jobcontext and setting the value for a workflow parameter
```
curl --data "orderid=2016_455882&wfparam1=89" http://loppem:4415/ws/accesspoint14
```

Doing a plain HTTP POST uploading a file and specifying the filename

curl --upload-file /Users/pipo/design1.pdf --request POST http://loppem:4415/ws/accesspoint14?filename=design1.pdf

Doing a plain HTTP POST to an AE-SaaS uploading a file, specifying the filename and supplying token authentication

curl --upload-file /Users/pipo/design1.pdf --request POST --header "From: design1.pdf" --header "AutomationEngine-Token: 9b07509e-64e6-48f4-955b-0bef3e064307" https://AEin.theDC.com/ws/accesspoint14

Doing a plain HTTP POST to an AE-SaaS uploading a file, specifying the filename and supplying basic authentication

curl --upload-file /Users/pipo/design1.pdf --request POST --header "From: design1.pdf" --user 'operator17:myPassword123!' https://AEin.theDC.com/ws/accesspoint14

HTTP request examples using bg_prog_fastservercltnt_vxyz\com_win\runapclient.bat

Doing a HTTPS POST with basic authentication uploading a file and specifying the filename and destination job

runapclient.bat -file 02-DDroge.ap -url "https://AEin.theDC.com/ws/WebAccessPoint2?filename=02-DDroge.ap&jobname=TestJob2" -usr operator17 -pw "myPassword123!"

Doing a HTTPS POST with token authentication uploading a file and specifying the filename and destination job

runapclient.bat -file 02-DDroge.ap -url "https://AEin.theDC.com/ws/WebAccessPoint2?filename=02-DDroge.ap&jobname=TestJob2" -aetoken c:\temp\tokens\aein_thedc-token.txt