Skip to main content
POST
/
deployment
/
create
Create
curl --request POST \
  --url http://{host}:{port}/{contextPath}/deployment/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'tenant-id=<string>' \
  --form 'deployment-source=<string>' \
  --form deploy-changed-only=false \
  --form enable-duplicate-filtering=false \
  --form 'deployment-name=<string>' \
  --form deployment-activation-time=2023-11-07T05:31:56Z \
  --form data=@example-file
{
  "links": [
    {
      "method": "GET",
      "href": "http://localhost:38080/rest-test/deployment/aDeploymentId",
      "rel": "self"
    }
  ],
  "id": "aDeploymentId",
  "name": "aName",
  "source": "process application",
  "deploymentTime": "2013-01-23T13:59:43.000+0200",
  "tenantId": null,
  "deployedProcessDefinitions": {
    "aProcDefId": {
      "id": "aProcDefId",
      "key": "aKey",
      "category": "aCategory",
      "description": "aDescription",
      "name": "aName",
      "version": 42,
      "resource": "aResourceName",
      "deploymentId": "aDeploymentId",
      "diagram": "aResourceName.png",
      "suspended": true,
      "tenantId": null,
      "versionTag": null
    }
  },
  "deployedCaseDefinitions": null,
  "deployedDecisionDefinitions": null,
  "deployedDecisionRequirementsDefinitions": null
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

multipart/form-data
​
tenant-id
string | null

The tenant id for the deployment to be created.

​
deployment-source
string | null

The source for the deployment to be created.

​
deploy-changed-only
boolean | null
default:false

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 source and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true.

​
enable-duplicate-filtering
boolean | null
default:false

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.

​
deployment-name
string | null

The name for the deployment to be created.

​
deployment-activation-time
string<date-time> | null

Sets the date on which the process definitions contained in this deployment will be activated. This means that all process definitions will be deployed as usual, but they will be suspended from the start until the given activation date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
data
file | null

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.

Response

Request successful.

​
deployedProcessDefinitions
object | null

A JSON Object containing a property for each of the process definitions, which are successfully deployed with that deployment. The key is the process definition id, the value is a JSON Object corresponding to the process definition.

​
deployedDecisionDefinitions
object | null

A JSON Object containing a property for each of the decision definitions, which are successfully deployed with that deployment. The key is the decision definition id, the value is a JSON Object corresponding to the decision definition.

​
deployedDecisionRequirementsDefinitions
object | null

A JSON Object containing a property for each of the decision requirements definitions, which are successfully deployed with that deployment. The key is the decision requirements definition id, the value is a JSON Object corresponding to the decision requirements definition.

​
deployedCaseDefinitions
object | null

A JSON Object containing a property for each of the case definitions, which are successfully deployed with that deployment. The key is the case definition id, the value is a JSON Object corresponding to the case definition.

​
id
string | null

The id of the deployment.

​
tenantId
string | null

The tenant id of the deployment.

​
deploymentTime
string<date-time> | null

The time when the deployment was created.

​
source
string | null

The source of the deployment.

​
name
string | null

The name of the deployment.

​
links
object[] | null

The links associated to this resource, with method, href and rel.