Process Definition

Submit Start Form

Starts a process instance using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See Documentation on Generated Task Forms.

post/process-definition/{id}/submit-form

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-definition/{id}/submit-form
  • Auth: HTTP basic

Path parameters

idstring required

The id of the process definition to submit the form for.

Request body

variablesobject nullable
businessKeystring nullable

The business key the process instance is to be initialized with. The business key uniquely identifies the process instance in the context of the given process definition.

Response

Request successful.

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.