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

resources binary[]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.

tenantId string

The tenant to deploy the resources to.

Responses

200

The resources are deployed.

application/json

Schema

Schema

deploymentKey int64

The unique key identifying the deployment.

deployments object[]
Items deployed by the request.
Array [
processDefinition object
A deployed process.
processDefinitionId string
The bpmn process ID, as parsed during deployment, together with the version forms a unique identifier for a specific process definition.
processDefinitionVersion int32
The assigned process version.
processDefinitionKey int64
The assigned key, which acts as a unique identifier for this process.
resourceName string
The resource name from which this process was parsed.
tenantId string
The tenant ID of the deployed process.
decisionDefinition object
A deployed decision.
decisionDefinitionId string
The dmn decision ID, as parsed during deployment, together with the version forms a unique identifier for a specific decision.
version int32
The assigned decision version.
decisionDefinitionKey int64
The assigned decision key, which acts as a unique identifier for this decision.
name string
The DMN name of the decision, as parsed during deployment.
tenantId string
The tenant ID of the deployed decision.
decisionRequirementsId string
The dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment.
decisionRequirementsKey int64
The assigned key of the decision requirements graph that this decision is part of.
decisionRequirements object
Deployed decision requirements.
decisionRequirementsId string
The dmn decision requirements ID, as parsed during deployment; together with the versions forms a unique identifier for a specific decision.
version int32
The assigned decision requirements version.
name string
The DMN name of the decision requirements, as parsed during deployment.
tenantId string
The tenant ID of the deployed decision requirements.
decisionRequirementsKey int64
The assigned decision requirements key, which acts as a unique identifier for this decision requirements.
resourceName string
The resource name from which this decision requirements was parsed.
form object
A deployed form.
formId string
The form ID, as parsed during deployment, together with the version forms a unique identifier for a specific form.
version int32
The assigned form version.
formKey int64
The assigned key, which acts as a unique identifier for this form.
resourceName string
The resource name from which this form was parsed.
tenantId string
The tenant ID of the deployed form.
]
tenantId string

The tenant ID associated with the deployment.

Example (from schema)

{
  "deploymentKey": 0,
  "deployments": [
    {
      "processDefinition": {
        "processDefinitionId": "string",
        "processDefinitionVersion": 0,
        "processDefinitionKey": 0,
        "resourceName": "string",
        "tenantId": "string"
      },
      "decisionDefinition": {
        "decisionDefinitionId": "string",
        "version": 0,
        "decisionDefinitionKey": 0,
        "name": "string",
        "tenantId": "string",
        "decisionRequirementsId": "string",
        "decisionRequirementsKey": 0
      },
      "decisionRequirements": {
        "decisionRequirementsId": "string",
        "version": 0,
        "name": "string",
        "tenantId": "string",
        "decisionRequirementsKey": 0,
        "resourceName": "string"
      },
      "form": {
        "formId": "string",
        "version": 0,
        "formKey": 0,
        "resourceName": "string",
        "tenantId": "string"
      }
    }
  ],
  "tenantId": "string"
}

400

The document upload failed. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...