2.11.2.RELEASE
[ Base URL: localhost:2002 ]
IMPORTANT - The Try it Out button will generate curl requests for examples, but executing them through the UI will not work as authentication has not been set up. This page is for documentation only.
List existing processes
No parameters
Code | Description |
200 | OK
|
401 | Authentication required |
Upload process configuration bundle. Bundle is a gzipped tarball (tar.gz) containing a config.json file (containing a Process object in json notation) and the associated resource files
Name | Description |
---|---|
file * file (formData) | file to upload |
Code | Description |
201 | Successful creation
|
401 | Authentication required |
403 | Forbidden - ADMIN role necessary |
Delete all existing process configuration data
No parameters
Code | Description |
204 | OK |
401 | Authentication required |
500 | Unable to delete processes |
Access configuration data for a given process
Name | Description |
---|---|
processId * string (path) | Id of the process to retrieve |
version string (query) | Expected version of process (defaults to latest) |
Code | Description |
200 | OK
|
401 | Authentication required |
Delete existing process configuration data
Name | Description |
---|---|
processId * string (path) | Id of the process to delete |
Code | Description |
204 | OK |
401 | Authentication required |
404 | Not found |
500 | Unable to delete process |
Get template, if file exists return file (application/handlebars) otherwise return error message (application/json)
Name | Description |
---|---|
processId * string (path) | Id of the process to retrieve |
templateName * string (path) | Name of template to retrieve (w.o. extension) |
locale string (query) | Locale iso code |
version string (query) | Expected version of template (defaults to latest) |
Code | Description |
200 | OK
|
401 | Authentication required |
404 | No such template |
Get css file, if file exists return file (text/css) otherwise return error message (application/json)
Name | Description |
---|---|
processId * string (path) | Id of the process to retrieve |
cssFileName * string (path) | Name of stylesheet file to retrieve (w.o. extension) |
version string (query) | Expected version of stylesheet (defaults to latest) |
Code | Description |
200 | OK
|
404 | No such template |
Get i18n file, if file exists return file (text/plain) otherwise return error message (application/json)
Name | Description |
---|---|
processId * string (path) | Id of the process to retrieve |
locale * string (query) | Locale iso code |
version string (query) | Expected version of i18n (defaults to latest) |
Code | Description |
200 | OK
|
401 | Authentication required |
404 | No such template |
Get response associated with a given state of a given process, returns a response (application/json)
Name | Description |
---|---|
processId * string (path) | Id of the process to retrieve |
state * string (path) | Name of state |
version string (query) | Required version of process (defaults to latest) |
Code | Description |
200 | OK
|
401 | Authentication required |
404 | No such process/state |
Delete specific version of the configuration data for a given process
Name | Description |
---|---|
processId * string (path) | Id of the process to delete |
version * string (path) | Version of process to delete |
Code | Description |
204 | OK |
401 | Authentication required |
404 | Not found |
500 | Unable to delete version of process |
Get the groups of processes
No parameters
Code | Description |
200 | OK
|
401 | Authentication required |
Upload file defining the groups of processes. This file must be in json format and is saved to disk, under the name 'processGroups.json'.
Name | Description |
---|---|
file * file (formData) | file to upload |
Code | Description |
201 | Successful creation |
401 | Authentication required |
403 | Forbidden - ADMIN role necessary |
Get the monitoring configuration
No parameters
Code | Description |
200 | OK
|
401 | Authentication required |
Post the json defining the monitoring config This json is saved to disk, under the name 'monitoring.json'.
Name | Description |
---|---|
monitoring (body) |
|
Code | Description |
201 | Successful creation |
401 | Authentication required |
403 | Forbidden - ADMIN role necessary |