Post Deployment
Creates a deployment.
Security Consideration
Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code. See the section on security considerations for custom code in the user guide for details.
Method
POST /deployment/create
Parameters
Request Body
A multipart form submit with the following parts:
| Form Part Name | Content Type | Description |
|---|---|---|
| deployment-name | text/plain | The name for the deployment to be created. |
| enable-duplicate-filtering | text/plain |
A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false.
|
| deploy-changed-only | text/plain |
A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true.
|
| deployment-source | text/plain | The source for the deployment to be created. |
| tenant-id | text/plain | The tenant id for the deployment to be created. |
| * | application/octet-stream | The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment. |
Result
A JSON object corresponding to the Deployment interface in the engine.
Its properties are as follows:
| Name | Value | Description |
|---|---|---|
| links | List | Link to the newly created deployment with method, href and rel. |
| id | String | The id of the deployment. |
| name | String | The name of the deployment. |
| source | String | The source of the deployment. |
| tenantId | String | The tenant id of the deployment. |
| deploymentTime | String | The time when the deployment was created. |
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | application/json | Request successful. |
Example
Request
Post data for a new deployment:
POST /deployment/create
--28319d96a8c54b529aa9159ad75edef9
Content-Disposition: form-data; name="deployment-name"
aName
--28319d96a8c54b529aa9159ad75edef9
Content-Disposition: form-data; name="enable-duplicate-filtering"
true
--28319d96a8c54b529aa9159ad75edef9
Content-Disposition: form-data; name="deployment-source"
process application
--28319d96a8c54b529aa9159ad75edef9
Content-Disposition: form-data; name="data"; filename="test.bpmn"
<?xml version="1.0" encoding="UTF-8"?>
<bpmn2:definitions ...>
<!-- BPMN 2.0 XML omitted -->
</bpmn2:definitions>
--28319d96a8c54b529aa9159ad75edef9--
Response
Status 200.
{
"links": [
{
"method": "GET",
"href": "http://localhost:38080/rest-test/deployment/aDeploymentId",
"rel": "self"
}
],
"id": "aDeploymentId",
"name": "aName",
"source": "process application",
"tenantId": null,
"deploymentTime": "2013-01-23T13:59:43"
}