Sign in
Process Definition

Start Instance

Instantiates a given process definition, starts the latest version of the process definition for tenant. Process variables and business key may be supplied in the request body.

post/process-definition/key/{key}/tenant-id/{tenant-id}/start

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-definition/key/{key}/tenant-id/{tenant-id}/start
  • Auth: HTTP basic

Path parameters

keystring required

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

tenant-idstring required

The id of the tenant the process definition belongs to.

Request body

businessKeystring nullable

The business key of the process instance.

variablesobject nullable
caseInstanceIdstring nullable

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

skipCustomListenersboolean nullable

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.

skipIoMappingsboolean nullable

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.

withVariablesInReturnboolean nullable

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

Response

Request successful.

variablesobject nullable

The id of the process instance.

idstring nullable

The id of the process instance.

definitionIdstring nullable

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

definitionKeystring nullable

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

businessKeystring nullable

The business key of the process instance.

caseInstanceIdstring nullable

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

endedboolean nullable

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

suspendedboolean nullable

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

tenantIdstring nullable

The tenant id of the process instance.

Changes

No recorded changes to this operation across all 1 revision of this API.