# \BpmnInstanceApi
All URIs are relative to */api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**bulk_migrate_bpmn_instances**](BpmnInstanceApi.md#bulk_migrate_bpmn_instances) | **POST** /w/{workspace}/bpmn/instances/migrate | migrate every running instance pinned to a definition version
[**cancel_bpmn_instance**](BpmnInstanceApi.md#cancel_bpmn_instance) | **POST** /w/{workspace}/bpmn/instances/cancel/{id} | cancel BPMN process instance
[**check_bpmn_instance_migration**](BpmnInstanceApi.md#check_bpmn_instance_migration) | **GET** /w/{workspace}/bpmn/instances/{id}/migration/check | check whether this instance can be migrated to a target version
[**check_bpmn_version_pair**](BpmnInstanceApi.md#check_bpmn_version_pair) | **GET** /w/{workspace}/bpmn/migration/check/p/{path} | check whether one BPMN definition version can be migrated to another
[**complete_bpmn_user_task**](BpmnInstanceApi.md#complete_bpmn_user_task) | **POST** /w/{workspace}/bpmn/instances/{id}/user-tasks/{user_task_id}/complete | complete a waiting BPMN user task
[**get_bpmn_flow_version_rollup**](BpmnInstanceApi.md#get_bpmn_flow_version_rollup) | **GET** /w/{workspace}/bpmn/instances/version_rollup/p/{path} | running instances of one BPMN flow, grouped by pinned definition version
[**get_bpmn_instance**](BpmnInstanceApi.md#get_bpmn_instance) | **GET** /w/{workspace}/bpmn/instances/get/{id} | get BPMN process instance
[**get_bpmn_instance_status**](BpmnInstanceApi.md#get_bpmn_instance_status) | **GET** /w/{workspace}/bpmn/instances/get/{id}/status | get BPMN process instance status
[**get_bpmn_version_rollup**](BpmnInstanceApi.md#get_bpmn_version_rollup) | **GET** /w/{workspace}/bpmn/instances/version_rollup | running BPMN instances grouped by the definition version they are pinned to
[**list_bpmn_incidents**](BpmnInstanceApi.md#list_bpmn_incidents) | **GET** /w/{workspace}/bpmn/instances/{id}/incidents | list BPMN process instance incidents
[**list_bpmn_instances**](BpmnInstanceApi.md#list_bpmn_instances) | **GET** /w/{workspace}/bpmn/instances/list | list BPMN process instances
[**list_pending_bpmn_user_tasks**](BpmnInstanceApi.md#list_pending_bpmn_user_tasks) | **GET** /w/{workspace}/bpmn/user-tasks/list | list the BPMN user tasks awaiting the current user
[**migrate_bpmn_instance**](BpmnInstanceApi.md#migrate_bpmn_instance) | **POST** /w/{workspace}/bpmn/instances/{id}/migrate | migrate one running BPMN process instance to another definition version
[**plan_bpmn_instance_migration**](BpmnInstanceApi.md#plan_bpmn_instance_migration) | **POST** /w/{workspace}/bpmn/instances/{id}/migration/plan | resolve an activity mapping document against this instance's pin
[**plan_bpmn_version_pair_migration**](BpmnInstanceApi.md#plan_bpmn_version_pair_migration) | **POST** /w/{workspace}/bpmn/migration/plan/p/{path} | resolve an activity mapping document against a BPMN version pair
[**preview_bpmn_instance**](BpmnInstanceApi.md#preview_bpmn_instance) | **POST** /w/{workspace}/bpmn/run/preview | run BPMN process preview (undeployed diagram)
[**retry_bpmn_incident**](BpmnInstanceApi.md#retry_bpmn_incident) | **POST** /w/{workspace}/bpmn/instances/{id}/incidents/{job_id}/retry | retry a BPMN process instance incident
[**start_bpmn_instance**](BpmnInstanceApi.md#start_bpmn_instance) | **POST** /w/{workspace}/bpmn/run/p/{path} | start BPMN process instance
## bulk_migrate_bpmn_instances
> models::BpmnMigrationResult bulk_migrate_bpmn_instances(workspace, bulk_migrate_bpmn_instances_request)
migrate every running instance pinned to a definition version
Bulk identity migration (#922). One validation for the whole batch, because eligibility is a property of the version pair, not of an instance. `from_version` is the whole bulk key -- a `bpmn_flow_version` row belongs to exactly one flow -- and both versions are checked to belong to the same flow before anything moves. Matching no running instance is a 200 with an empty `migrated`, not an error.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**bulk_migrate_bpmn_instances_request** | [**BulkMigrateBpmnInstancesRequest**](BulkMigrateBpmnInstancesRequest.md) | | [required] |
### Return type
[**models::BpmnMigrationResult**](BpmnMigrationResult.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## cancel_bpmn_instance
> String cancel_bpmn_instance(workspace, id, cancel_bpmn_instance)
cancel BPMN process instance
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **uuid::Uuid** | | [required] |
**cancel_bpmn_instance** | [**CancelBpmnInstance**](CancelBpmnInstance.md) | cancel reason | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## check_bpmn_instance_migration
> models::BpmnMigrationCheck check_bpmn_instance_migration(workspace, id, target_version)
check whether this instance can be migrated to a target version
The same per-pair verdict as checkBpmnVersionPair, but resolving this instance's own current pin and its runtime preconditions (it must not be an inline preview run, and it must still be running).
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **uuid::Uuid** | | [required] |
**target_version** | **i64** | | [required] |
### Return type
[**models::BpmnMigrationCheck**](BpmnMigrationCheck.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## check_bpmn_version_pair
> models::BpmnMigrationCheck check_bpmn_version_pair(workspace, path, from_version, to_version)
check whether one BPMN definition version can be migrated to another
Runs the identity-migration contract (#922) over two compiled definitions of the same flow and reports every blocker, grouped by rule. Reads no runtime state at all, so the verdict is a property of the (from_version, to_version) *pair* and applies to every instance pinned to from_version -- which is what makes it answerable with no instance and cacheable per version.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**path** | **String** | | [required] |
**from_version** | **i64** | | [required] |
**to_version** | **i64** | | [required] |
### Return type
[**models::BpmnMigrationCheck**](BpmnMigrationCheck.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## complete_bpmn_user_task
> String complete_bpmn_user_task(workspace, id, user_task_id, request_body)
complete a waiting BPMN user task
Deliver a user task's form data and unpark the instance. The body is the completion payload; when the task declares form fields it is validated against them server-side (required fields, declared defaults, enum values -- see #833), unless the model sets `flowable:formFieldValidation=\"false\"`. Since #1104 the caller must be in the task's declared audience. This was previously unenforced: anyone who could see an instance could complete any of its user tasks, including one assigned to somebody else.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **uuid::Uuid** | the process instance id | [required] |
**user_task_id** | **String** | the `<userTask>` element id | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_bpmn_flow_version_rollup
> models::BpmnVersionRollup get_bpmn_flow_version_rollup(workspace, path, check)
running instances of one BPMN flow, grouped by pinned definition version
#919, narrowed to a single flow. Identical shape to the workspace rollup. A flow that exists but has nothing running answers with an empty `flows` list, not a 404.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**path** | **String** | | [required] |
**check** | Option<**bool**> | | |[default to true]
### Return type
[**models::BpmnVersionRollup**](BpmnVersionRollup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_bpmn_instance
> models::BpmnInstanceDetail get_bpmn_instance(workspace, id)
get BPMN process instance
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **uuid::Uuid** | | [required] |
### Return type
[**models::BpmnInstanceDetail**](BpmnInstanceDetail.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_bpmn_instance_status
> models::ProcessInstanceStatus get_bpmn_instance_status(workspace, id)
get BPMN process instance status
Frontend-facing projection of the process instance's live runtime state (lifecycle, per-activity status, variables, history, incidents), consumed by the live process token overlay. 404 if the instance isn't in the workspace, or if the engine has not picked it up yet (no runtime state).
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **uuid::Uuid** | | [required] |
### Return type
[**models::ProcessInstanceStatus**](ProcessInstanceStatus.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_bpmn_version_rollup
> models::BpmnVersionRollup get_bpmn_version_rollup(workspace, check)
running BPMN instances grouped by the definition version they are pinned to
#919. Answers \"which of my running instances are on an old definition?\" for the whole workspace, and per pinned version whether it is migratable to that flow's latest and if not why (#922's validator, computed once per version because eligibility is a property of the (version, latest) pair rather than of an instance). Read-only. An instance is pinned at start to one `bpmn_flow_version` (`v2_job.runnable_id`) and resolves its model from that row on every step, so instances complete on the version they started on while new starts use the latest. `runnable_id` is the source here, never the denormalised `bpmn_process_status.bpmn_version`, which the engine writes on insert and never refreshes. \"Running\" means a root instance still queued and uncancelled -- the same set a bulk migrate would move. Inline preview runs are excluded: they carry their model on the job row and are on no version.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**check** | Option<**bool**> | Set false to return counts only and skip every per-version migratability check. `migratable_to_latest` then comes back null with `check_error` saying so, never false. | |[default to true]
### Return type
[**models::BpmnVersionRollup**](BpmnVersionRollup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_bpmn_incidents
> Vec<models::BpmnIncident> list_bpmn_incidents(workspace, id)
list BPMN process instance incidents
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **uuid::Uuid** | | [required] |
### Return type
[**Vec<models::BpmnIncident>**](BpmnIncident.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_bpmn_instances
> Vec<models::BpmnInstanceSummary> list_bpmn_instances(workspace, page, per_page)
list BPMN process instances
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) | |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) | |
### Return type
[**Vec<models::BpmnInstanceSummary>**](BpmnInstanceSummary.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_pending_bpmn_user_tasks
> Vec<models::PendingUserTask> list_pending_bpmn_user_tasks(workspace, page, per_page)
list the BPMN user tasks awaiting the current user
Every `<userTask>` in the workspace that is parked awaiting a human and that the caller may act on (#1104). This is the read side the completion operation below always presumed: that operation is addressed by `(instance id, element id)`, which a human has no way to discover otherwise. Filtering is **server-side and is the same rule the completion operation enforces**. A task is returned when the caller is an admin, when the task declares no assignment it can resolve, or when the caller matches a declared literal `assignee`/`owner`/`candidateUsers` entry or one of the `candidateGroups`. Assignment written as an expression (`${approver}`) cannot be resolved on this path -- there is no runtime identity resolution in the engine -- and is reported via `assignment_unresolved` rather than guessed at. Pagination applies to process *instances*, not to tasks: one instance can hold several parked tasks on parallel branches.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) | |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) | |
### Return type
[**Vec<models::PendingUserTask>**](PendingUserTask.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## migrate_bpmn_instance
> models::BpmnMigrationResult migrate_bpmn_instance(workspace, id, migrate_bpmn_instance_request)
migrate one running BPMN process instance to another definition version
Validated pointer swap (#922). Validates the (current, target) pair against the identity-migration contract and, only if it passes, moves `v2_job.runnable_id` to the target version, refreshes the denormalised `bpmn_process_status.bpmn_version` (which no engine writer ever refreshes) and appends a `bpmn_instance_migration` ledger row -- all in one transaction. `process_status` is never written and `suspend_until` is never nudged; the instance runs on the target version from its next step, because the engine re-resolves the pinned definition on every step. A pair that fails the contract is refused with a 400 naming every offending identifier -- it is never migrated and flagged.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **uuid::Uuid** | | [required] |
**migrate_bpmn_instance_request** | [**MigrateBpmnInstanceRequest**](MigrateBpmnInstanceRequest.md) | | [required] |
### Return type
[**models::BpmnMigrationResult**](BpmnMigrationResult.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## plan_bpmn_instance_migration
> models::BpmnMigrationPlanCheck plan_bpmn_instance_migration(workspace, id, plan_bpmn_instance_migration_request)
resolve an activity mapping document against this instance's pin
The same resolution as planBpmnVersionPairMigration, but resolving this instance's own current pin and its runtime preconditions (it must not be an inline preview run, and it must still be running). Writes nothing.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **uuid::Uuid** | | [required] |
**plan_bpmn_instance_migration_request** | [**PlanBpmnInstanceMigrationRequest**](PlanBpmnInstanceMigrationRequest.md) | | [required] |
### Return type
[**models::BpmnMigrationPlanCheck**](BpmnMigrationPlanCheck.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## plan_bpmn_version_pair_migration
> models::BpmnMigrationPlanCheck plan_bpmn_version_pair_migration(workspace, path, plan_bpmn_version_pair_migration_request)
resolve an activity mapping document against a BPMN version pair
Runs the *mapped* migration contract (#925, stage 4) over two compiled definitions of the same flow and, if the document holds, returns the resolved substitution as a plan. `POST` because the mapping is a document rather than a query parameter -- the call reads two definitions and **writes nothing**. Where the identity contract (checkBpmnVersionPair) asks \"may this instance run on the target unchanged\", this asks the strictly larger \"may it run on the target after renaming the identifiers this document names\". It admits renames -- of elements, of sequence flows (derived from their endpoints, never declared) and of the process id -- and refuses every topological change: a deleted activity with no replacement, an N:1 merge, a cross-scope move, a changed set of incoming flows, a re-attached boundary event. An element the document does not name is implicitly mapped to its own id, and is then subject to every rule an explicit mapping is. An element that is neither named nor present in the target is a hard refusal (`activity_deleted`), never a silently dropped token. Note `executable_today`: the engine-side rewrite that applies a plan is not built, so only an identity plan can currently be performed (by migrateBpmnInstance). A non-identity plan is a validated statement of what would be rewritten, not a promise that it can be.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**path** | **String** | | [required] |
**plan_bpmn_version_pair_migration_request** | [**PlanBpmnVersionPairMigrationRequest**](PlanBpmnVersionPairMigrationRequest.md) | | [required] |
### Return type
[**models::BpmnMigrationPlanCheck**](BpmnMigrationPlanCheck.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## preview_bpmn_instance
> String preview_bpmn_instance(workspace, preview_bpmn_instance)
run BPMN process preview (undeployed diagram)
Start a process instance from an undeployed diagram (#710 stage 3), the \"run without deploying\" counterpart to `POST /bpmn/run/p/{path}`. The submitted XML is parsed and validated exactly as a real deploy would -- nothing is written to `bpmn_flow`/`bpmn_flow_version`.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**preview_bpmn_instance** | [**PreviewBpmnInstance**](PreviewBpmnInstance.md) | inline BPMN XML plus initial process variables | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain, application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## retry_bpmn_incident
> String retry_bpmn_incident(workspace, id, job_id)
retry a BPMN process instance incident
Validates the ActivityFailed incident, identified by the original failed child job's id, and records a retry intent on the process instance. The execution engine does not yet act on this intent: retrying an incident is not yet functional end-to-end. This endpoint only validates ownership of the incident and records the intent for a future engine version to consume.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **uuid::Uuid** | | [required] |
**job_id** | **uuid::Uuid** | the failed child job id identifying the incident to retry (Incident.job) | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## start_bpmn_instance
> String start_bpmn_instance(workspace, path, start_bpmn_instance)
start BPMN process instance
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**path** | **String** | | [required] |
**start_bpmn_instance** | [**StartBpmnInstance**](StartBpmnInstance.md) | initial process variables | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)