Deploy resources
POST/deployments
Deploys one or more resources (e.g. processes, decision models, or forms). This is an atomic call, i.e. either all resources are deployed or none of them are.
Request
- multipart/form-data
Body
required
The binary data to create the deployment resources. It is possible to have more than one form part with different form part names for the binary data to create a deployment.
The tenant to deploy the resources to.
Responses
- 200
- 400
The resources are deployed.
- application/json
- application/vnd.camunda.api.keys.number+json
- application/vnd.camunda.api.keys.string+json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The tenant ID associated with the deployment.
The unique key identifying the deployment.
deployments object[]
Items deployed by the request.
processDefinition object
Base properties for DeploymentProcess.
The bpmn process ID, as parsed during deployment, together with the version forms a unique identifier for a specific process definition.
The assigned process version.
The resource name from which this process was parsed.
The tenant ID of the deployed process.
decisionDefinition object
Base properties for DeploymentDecision.
The dmn decision ID, as parsed during deployment, together with the version forms a unique identifier for a specific decision.
The assigned decision version.
The DMN name of the decision, as parsed during deployment.
The tenant ID of the deployed decision.
The dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment.
decisionRequirements object
Base properties for DeploymentDecisionRequirements.
The dmn decision requirements ID, as parsed during deployment; together with the versions forms a unique identifier for a specific decision.
The assigned decision requirements version.
The DMN name of the decision requirements, as parsed during deployment.
The tenant ID of the deployed decision requirements.
The resource name from which this decision requirements was parsed.
form object
Base properties for DeploymentForm.
The form ID, as parsed during deployment, together with the version forms a unique identifier for a specific form.
The assigned form version.
The resource name from which this form was parsed.
The tenant ID of the deployed form.
{
"deploymentKey": "string",
"deployments": [
{
"processDefinition": {
"processDefinitionId": "string",
"processDefinitionVersion": 0,
"resourceName": "string",
"tenantId": "string"
},
"decisionDefinition": {
"decisionDefinitionId": "string",
"version": 0,
"name": "string",
"tenantId": "string",
"decisionRequirementsId": "string"
},
"decisionRequirements": {
"decisionRequirementsId": "string",
"version": 0,
"name": "string",
"tenantId": "string",
"resourceName": "string"
},
"form": {
"formId": "string",
"version": 0,
"resourceName": "string",
"tenantId": "string"
}
}
],
"tenantId": "string"
}
- Schema
- Example (from schema)
Schema
- Array [
- ]
The tenant ID associated with the deployment.
The unique key identifying the deployment.
deployments object[]
Items deployed by the request.
processDefinition object
Base properties for DeploymentProcess.
The bpmn process ID, as parsed during deployment, together with the version forms a unique identifier for a specific process definition.
The assigned process version.
The resource name from which this process was parsed.
The tenant ID of the deployed process.
decisionDefinition object
Base properties for DeploymentDecision.
The dmn decision ID, as parsed during deployment, together with the version forms a unique identifier for a specific decision.
The assigned decision version.
The DMN name of the decision, as parsed during deployment.
The tenant ID of the deployed decision.
The dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment.
decisionRequirements object
Base properties for DeploymentDecisionRequirements.
The dmn decision requirements ID, as parsed during deployment; together with the versions forms a unique identifier for a specific decision.
The assigned decision requirements version.
The DMN name of the decision requirements, as parsed during deployment.
The tenant ID of the deployed decision requirements.
The resource name from which this decision requirements was parsed.
form object
Base properties for DeploymentForm.
The form ID, as parsed during deployment, together with the version forms a unique identifier for a specific form.
The assigned form version.
The resource name from which this form was parsed.
The tenant ID of the deployed form.
{
"deploymentKey": 0,
"deployments": [
{
"processDefinition": {
"processDefinitionId": "string",
"processDefinitionVersion": 0,
"resourceName": "string",
"tenantId": "string"
},
"decisionDefinition": {
"decisionDefinitionId": "string",
"version": 0,
"name": "string",
"tenantId": "string",
"decisionRequirementsId": "string"
},
"decisionRequirements": {
"decisionRequirementsId": "string",
"version": 0,
"name": "string",
"tenantId": "string",
"resourceName": "string"
},
"form": {
"formId": "string",
"version": 0,
"resourceName": "string",
"tenantId": "string"
}
}
],
"tenantId": "string"
}
- Schema
- Example (from schema)
Schema
- Array [
- ]
The tenant ID associated with the deployment.
The unique key identifying the deployment.
deployments object[]
Items deployed by the request.
processDefinition object
Base properties for DeploymentProcess.
The bpmn process ID, as parsed during deployment, together with the version forms a unique identifier for a specific process definition.
The assigned process version.
The resource name from which this process was parsed.
The tenant ID of the deployed process.
decisionDefinition object
Base properties for DeploymentDecision.
The dmn decision ID, as parsed during deployment, together with the version forms a unique identifier for a specific decision.
The assigned decision version.
The DMN name of the decision, as parsed during deployment.
The tenant ID of the deployed decision.
The dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment.
decisionRequirements object
Base properties for DeploymentDecisionRequirements.
The dmn decision requirements ID, as parsed during deployment; together with the versions forms a unique identifier for a specific decision.
The assigned decision requirements version.
The DMN name of the decision requirements, as parsed during deployment.
The tenant ID of the deployed decision requirements.
The resource name from which this decision requirements was parsed.
form object
Base properties for DeploymentForm.
The form ID, as parsed during deployment, together with the version forms a unique identifier for a specific form.
The assigned form version.
The resource name from which this form was parsed.
The tenant ID of the deployed form.
{
"deploymentKey": "string",
"deployments": [
{
"processDefinition": {
"processDefinitionId": "string",
"processDefinitionVersion": 0,
"resourceName": "string",
"tenantId": "string"
},
"decisionDefinition": {
"decisionDefinitionId": "string",
"version": 0,
"name": "string",
"tenantId": "string",
"decisionRequirementsId": "string"
},
"decisionRequirements": {
"decisionRequirementsId": "string",
"version": 0,
"name": "string",
"tenantId": "string",
"resourceName": "string"
},
"form": {
"formId": "string",
"version": 0,
"resourceName": "string",
"tenantId": "string"
}
}
],
"tenantId": "string"
}
The document upload failed. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}