Skip to main content
POST
/
process-definition
/
key
/
{key}
/
tenant-id
/
{tenant-id}
/
start
curl --request POST \
  --url http://{host}:{port}/{contextPath}/process-definition/key/{key}/tenant-id/{tenant-id}/start \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variables": {
    "aVariable": {
      "value": "aStringValue",
      "type": "String"
    },
    "anotherVariable": {
      "value": true,
      "type": "Boolean"
    }
  },
  "businessKey": "myBusinessKey"
}
'
{
  "links": [
    {
      "method": "GET",
      "href": "http://localhost:8080/rest-test/process-instance/anId",
      "rel": "self"
    }
  ],
  "id": "anId",
  "definitionId": "aProcessDefinitionId",
  "businessKey": "myBusinessKey",
  "caseInstanceId": null,
  "tenantId": null,
  "ended": false,
  "suspended": false
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
key
string
required

The key of the process definition (the latest version thereof) to be retrieved.

​
tenant-id
string
required

The id of the tenant the process definition belongs to.

Body

application/json
​
businessKey
string | null

The business key of the process instance.

​
variables
object
​
caseInstanceId
string | null

The case instance id the process instance is to be initialized with.

​
startInstructions
object[] | null

Optional. A JSON array of instructions that specify which activities to start the process instance at. If this property is omitted, the process instance starts at its default blank start event.

​
skipCustomListeners
boolean | null

Skip execution listener invocation for activities that are started or ended as part of this request. Note: This option is currently only respected when start instructions are submitted via the startInstructions property.

​
skipIoMappings
boolean | null

Skip execution of input/output variable mappings for activities that are started or ended as part of this request. Note: This option is currently only respected when start instructions are submitted via the startInstructions property.

​
withVariablesInReturn
boolean | null

Indicates if the variables, which was used by the process instance during execution, should be returned. Default value: false

Response

Request successful.

​
variables
object

The id of the process instance.

​
id
string | null

The id of the process instance.

​
definitionId
string | null

The id of the process definition that this process instance belongs to.

​
businessKey
string | null

The business key of the process instance.

​
caseInstanceId
string | null

The id of the case instance associated with the process instance.

​
ended
boolean | null
deprecated

A flag indicating whether the process instance has ended or not. Deprecated: will always be false!

​
suspended
boolean | null

A flag indicating whether the process instance is suspended or not.

​
tenantId
string | null

The tenant id of the process instance.

​
links
object[] | null

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