Execution Environment Entrypoint
Summary
The Execution Environment Entrypoint can be used to start at job with a deployment defined in CAMEL and a Workflow file for the Activiti component.
Architecture Design
It is designed as a light-weight, monolithic http server to manage jobs with BPaaS bundles to be executed.
Installation manual
The installation manual is currently only open for interal developers: Internal repository
Test cases
Test cases are currently internal.
API specification
The Execution Environment Entrypoint offers a RESTful interface.
Usage
GET /job
Description
This action returns the currently active jobs within the system.
Example
[
{
"id": 1,
"status": "FAILED",
"log": "Execution started...",
"startDate": "2016/01/21 15:23:50",
"endDate": null,
"fileBase64": "",
"deploymentFile": "...",
"workflowFile": "...",
"mappingFile": "",
"orderId": "asd"
}
]
GET /job/{uuid}
Description
This action returns the job registered under the given {uuid}.
Parameters
| Parameter | Type | Description |
|---|---|---|
| uuid | string | The identifier of the job. Mandatory. |
Example
GET /job/1
{
"id": 1,
"status": "FAILED",
"log": "Execution started...",
"startDate": "2016/01/21 15:23:50",
"endDate": null,
"fileBase64": "",
"deploymentFile": "...",
"workflowFile": "...",
"mappingFile": "",
"orderId": "asd"
}
POST /job
Description
This action creates a new job. After successfull creating the new job will be returned. See GET.
Parameters
| Parameter | Type | Description |
|---|---|---|
| fileBase64 | string | A file containing the deployment and workflow base64-encoded. See details below under file description. |
| orderId | string | The ID of the order associated with the job |
Example
POST /job
{
"fileBase64": "--base64--",
"orderId": "asd"
}
DELETE /job/{uuid}
Description
Deletes the job with the given {uuid}
Example
DELETE /job/1
File description
The file has to be base64-encoded and the raw content before encoding has to be of the following format:
{
"workflow": "base64-encoded Activiti workflow file",
"deployment": "base64-encoded CAMEL file describing the deployment"
}
Security
The interface offers a basic http authentication. This is only secure when using a SSL connection.