Create process instanceAdded in 8.6
POST/process-instances
Strongly Consistent About endpoint data consistency
Creates and starts an instance of the specified process. The process definition to use to create the instance can be specified either using its unique key (as returned by Deploy resources), or using the BPMN process id and a version. If only the process definition id is given, the latest ACTIVE version is used. If no ACTIVE version exists, the request is rejected as not found.
Waits for the completion of the process instance before returning a result when awaitCompletion is enabled.
Request
Responses
- 200
- 400
- 409
- 500
- 503
- 504
The process instance was created.
The provided data is not valid.
The process instance creation was rejected due to a business ID uniqueness conflict. This can happen only when Business ID Uniqueness Control is enabled and an active root process instance with the provided business ID already exists for the same process definition and tenant.
An internal error occurred while processing the request.
The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains RESOURCE_EXHAUSTED. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure .
The process instance creation request timed out in the gateway.
This can happen if the awaitCompletion request parameter is set to true
and the created process instance did not complete within the defined request timeout.
This often happens when the created instance is not fully automated or contains wait states.