You are here
Create a Workflow Process via REST (curl)
Creation of a process via an HTTP PUT is essentially the same as creation of a route via a WebDAV client as REST is a subset of WebDAV. The input message payload for the process must be PUT as an object named InputMessage in the Route's container. XATTRs (extended attributes) can be set using URL parameters; the ability to set XATTR values is an advantage REST has over most WebDAV clients.
Here is an example of create a process instance of the workflow route "V200TmpxrefrLoad" with an InputMessage from the local file "Desktop/tvh_20194.zip" and XATTRs named "update", "effective", "taskid", and "batchid".
awilliam@beast01:~> curl -v -u fred -T Desktop/tvh_20194.zip 'http://coils.example.com/dav/Workflow/Routes/V200TmpxrefrLoad/InputMessage?update=2019-04-03&effective=2019-04-03&taskid=1063257439&batchid=v200-04/19'
Enter host password for user 'fred':
* Hostname was NOT found in DNS cache
* Trying 192.168.1.65...
* Connected to coils.example.com (192.168.1.65) port 80 (#0)
* Server auth using Basic with user 'fred'
> PUT /dav/Workflow/Routes/V200TmpxrefrLoad/InputMessage?update=2019-04-03&effective=2019-04-03&taskid=1063257439&batchid=v200-04/19 HTTP/1.1
> Authorization: Basic **************==
> User-Agent: curl/7.37.0
> Host: coils.example.com
> Accept: */*
> Content-Length: 44473641
> Expect: 100-continue
>
< HTTP/1.1 100 Continue
* We are completely uploaded and fine
< HTTP/1.1 301 Moved
* Server nginx/1.12.2 is not blacklisted
< Server: nginx/1.12.2
< Date: Tue, 09 Apr 2019 18:13:49 GMT
< Content-Type: application/octet-stream
< Content-Length: 0
< Connection: keep-alive
< Set-Cookie: OGOCOILSESSIONID=f9c4efe4-2091-4229-8ac7-68b6fd4a8478-13bb3be8-fae8-472b-9999-514eac324614-3cf33404-c58e-4727-bac1-1754711b9344; Domain=coils.example.com; expires=Wed, 10-Apr-2019 18:13:49 UTC; Path=/
< X-COILS-WORKFLOW-OUTPUT-URL: /dav/Workflow/Routes/V200TmpxrefrLoad/1065656529/output
< X-COILS-WORKFLOW-MESSAGE-LABEL: InputMessage
< X-COILS-WORKFLOW-PROCESS-ID: 1065656529
< Location: /dav/Workflow/Routes/V200TmpxrefrLoad/1065656529/input
< X-COILS-WORKFLOW-MESSAGE-UUID: {688a86f2-3898-4d66-8c47-7393fa9fbad6}
<
* Connection #0 to host coils.example.com left intact
Success is indicated by an HTTP/301 response. The headers in the response provide important meta-data which may be of use to the client.
| Header | Description |
|---|---|
| X-COILS-WORKFLOW-OUTPUT-URL | The URL to watch for the process' output message. |
| X-COILS-WORKFLOW-MESSAGE-LABEL | The label assigned to the new message; this will typically be “InputMessage”. |
| X-COILS-WORKFLOW-PROCESS-ID | The object id of the new process entity. |
| X-COILS-WORKFLOW-MESSAGE-UUID | The UUID of the new message. |
The priority of the new process can be set to a value other than the default of 201 using the URL parameter ".priority". The value must be a permissible integer priority value. Note that this parameter has a prefix of "." in order to distiguish it from an XATTR value.
In the circumstance where the creation of the processes is quashed by run control the response will be HTTP/202. The HTTP/202 response will have a header of X-COILS-WORKFLOW-ALERT with a value of “run-control violation” and the body of the response will describe the event.