OpenApi Spec for Camunda BPM REST API.
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
Put the package under your project folder and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./generated" }All URIs are relative to http://localhost:8080/engine-rest
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ConditionApi | evaluate_condition | post /condition | |
| DeploymentApi | create_deployment | post /deployment/create | |
| DeploymentApi | delete_deployment | delete /deployment/{id} | |
| DeploymentApi | get_deployment | get /deployment/{id} | |
| DeploymentApi | get_deployment_resource | get /deployment/{id}/resources/{resourceId} | |
| DeploymentApi | get_deployment_resource_data | get /deployment/{id}/resources/{resourceId}/data | |
| DeploymentApi | get_deployment_resources | get /deployment/{id}/resources | |
| DeploymentApi | get_deployments | get /deployment | |
| DeploymentApi | get_deployments_count | get /deployment/count | |
| DeploymentApi | redeploy | post /deployment/{id}/redeploy | |
| EngineApi | get_process_engine_names | get /engine | |
| EventSubscriptionApi | get_event_subscriptions | get /event-subscription | |
| EventSubscriptionApi | get_event_subscriptions_count | get /event-subscription/count | |
| ExternalTaskApi | complete_external_task_resource | post /external-task/{id}/complete | |
| ExternalTaskApi | extend_lock | post /external-task/{id}/extendLock | |
| ExternalTaskApi | fetch_and_lock | post /external-task/fetchAndLock | |
| ExternalTaskApi | get_external_task | get /external-task/{id} | |
| ExternalTaskApi | get_external_task_error_details | get /external-task/{id}/errorDetails | |
| ExternalTaskApi | get_external_tasks | get /external-task | |
| ExternalTaskApi | get_external_tasks_count | get /external-task/count | |
| ExternalTaskApi | get_topic_names | get /external-task/topic-names | |
| ExternalTaskApi | handle_external_task_bpmn_error | post /external-task/{id}/bpmnError | |
| ExternalTaskApi | handle_failure | post /external-task/{id}/failure | |
| ExternalTaskApi | query_external_tasks | post /external-task | |
| ExternalTaskApi | query_external_tasks_count | post /external-task/count | |
| ExternalTaskApi | set_external_task_resource_priority | put /external-task/{id}/priority | |
| ExternalTaskApi | set_external_task_resource_retries | put /external-task/{id}/retries | |
| ExternalTaskApi | set_external_task_retries | put /external-task/retries | |
| ExternalTaskApi | set_external_task_retries_async_operation | post /external-task/retries-async | |
| ExternalTaskApi | unlock | post /external-task/{id}/unlock | |
| MessageApi | deliver_message | post /message | |
| MetricsApi | get_metrics | get /metrics/{metrics-name}/sum | |
| MetricsApi | interval | get /metrics | |
| ProcessDefinitionApi | delete_process_definition | delete /process-definition/{id} | Delete |
| ProcessDefinitionApi | delete_process_definitions_by_key | delete /process-definition/key/{key} | Delete By Key |
| ProcessDefinitionApi | delete_process_definitions_by_key_and_tenant_id | delete /process-definition/key/{key}/tenant/{tenant-id} | Delete By Key |
| ProcessDefinitionApi | get_activity_statistics | get /process-definition/{id}/statistics | Get Activity Instance Statistics |
| ProcessDefinitionApi | get_activity_statistics_by_process_definition_key | get /process-definition/key/{key}/statistics | Get Activity Instance Statistics |
| ProcessDefinitionApi | get_activity_statistics_by_process_definition_key_and_tenant_id | get /process-definition/key/{key}/tenant/{tenant-id}/statistics | Get Activity Instance Statistics |
| ProcessDefinitionApi | get_deployed_start_form | get /process-definition/{id}/deployed-start-form | Get Deployed Start Form |
| ProcessDefinitionApi | get_deployed_start_form_by_key | get /process-definition/key/{key}/deployed-start-form | Get Deployed Start Form |
| ProcessDefinitionApi | get_deployed_start_form_by_key_and_tenant_id | get /process-definition/key/{key}/tenant/{tenant-id}/deployed-start-form | Get Deployed Start Form |
| ProcessDefinitionApi | get_latest_process_definition_by_tenant_id | get /process-definition/key/{key}/tenant/{tenant-id} | Get |
| ProcessDefinitionApi | get_process_definition | get /process-definition/{id} | Get |
| ProcessDefinitionApi | get_process_definition_bpmn20_xml | get /process-definition/{id}/xml | Get XML |
| ProcessDefinitionApi | get_process_definition_bpmn20_xml_by_key | get /process-definition/key/{key}/xml | Get XML |
| ProcessDefinitionApi | get_process_definition_bpmn20_xml_by_key_and_tenant_id | get /process-definition/key/{key}/tenant/{tenant-id}/xml | Get XML |
| ProcessDefinitionApi | get_process_definition_by_key | get /process-definition/key/{key} | Get |
| ProcessDefinitionApi | get_process_definition_diagram | get /process-definition/{id}/diagram | Get Diagram |
| ProcessDefinitionApi | get_process_definition_diagram_by_key | get /process-definition/key/{key}/diagram | Get Diagram |
| ProcessDefinitionApi | get_process_definition_diagram_by_key_and_tenant_id | get /process-definition/key/{key}/tenant/{tenant-id}/diagram | Get Diagram |
| ProcessDefinitionApi | get_process_definition_statistics | get /process-definition/statistics | Get Process Instance Statistics |
| ProcessDefinitionApi | get_process_definitions | get /process-definition | Get List |
| ProcessDefinitionApi | get_process_definitions_count | get /process-definition/count | Get List Count |
| ProcessDefinitionApi | get_rendered_start_form | get /process-definition/{id}/rendered-form | Get Rendered Start Form |
| ProcessDefinitionApi | get_rendered_start_form_by_key | get /process-definition/key/{key}/rendered-form | Get Rendered Start Form |
| ProcessDefinitionApi | get_rendered_start_form_by_key_and_tenant_id | get /process-definition/key/{key}/tenant/{tenant-id}/rendered-form | Get Rendered Start Form |
| ProcessDefinitionApi | get_start_form | get /process-definition/{id}/startForm | Get Start Form Key |
| ProcessDefinitionApi | get_start_form_by_key | get /process-definition/key/{key}/startForm | Get Start Form Key |
| ProcessDefinitionApi | get_start_form_by_key_and_tenant_id | get /process-definition/key/{key}/tenant/{tenant-id}/startForm | Get Start Form Key |
| ProcessDefinitionApi | get_start_form_variables | get /process-definition/{id}/form-variables | Get Start Form Variables |
| ProcessDefinitionApi | get_start_form_variables_by_key | get /process-definition/key/{key}/form-variables | Get Start Form Variables |
| ProcessDefinitionApi | get_start_form_variables_by_key_and_tenant_id | get /process-definition/key/{key}/tenant/{tenant-id}/form-variables | Get Start Form Variables |
| ProcessDefinitionApi | restart_process_instance | post /process-definition/{id}/restart | Restart Process Instance |
| ProcessDefinitionApi | restart_process_instance_async_operation | post /process-definition/{id}/restart-async | Restart Process Instance Async |
| ProcessDefinitionApi | start_process_instance | post /process-definition/{id}/start | Start Instance |
| ProcessDefinitionApi | start_process_instance_by_key | post /process-definition/key/{key}/start | Start Instance |
| ProcessDefinitionApi | start_process_instance_by_key_and_tenant_id | post /process-definition/key/{key}/tenant/{tenant-id}/start | Start Instance |
| ProcessDefinitionApi | submit_form | post /process-definition/{id}/submit-form | Submit Start Form |
| ProcessDefinitionApi | submit_form_by_key | post /process-definition/key/{key}/submit-form | Submit Start Form |
| ProcessDefinitionApi | submit_form_by_key_and_tenant_id | post /process-definition/key/{key}/tenant/{tenant-id}/submit-form | Submit Start Form |
| ProcessDefinitionApi | update_history_time_to_live_by_process_definition_id | put /process-definition/{id}/history-time-to-live | Update History Time to Live |
| ProcessDefinitionApi | update_history_time_to_live_by_process_definition_key | put /process-definition/key/{key}/history-time-to-live | Update History Time to Live |
| ProcessDefinitionApi | update_history_time_to_live_by_process_definition_key_and_tenant_id | put /process-definition/key/{key}/tenant/{tenant-id}/history-time-to-live | Update History Time to Live |
| ProcessDefinitionApi | update_process_definition_suspension_state | put /process-definition/suspended | Activate/Suspend By Key |
| ProcessDefinitionApi | update_process_definition_suspension_state_by_id | put /process-definition/{id}/suspended | Activate/Suspend By Id |
| ProcessDefinitionApi | update_process_definition_suspension_state_by_key | put /process-definition/key/{key}/suspended | Activate/Suspend by Id |
| ProcessDefinitionApi | update_process_definition_suspension_state_by_key_and_tenant_id | put /process-definition/key/{key}/tenant/{tenant-id}/suspended | Activate/Suspend by Id |
| ProcessInstanceApi | delete_async_historic_query_based | post /process-instance/delete-historic-query-based | |
| ProcessInstanceApi | delete_process_instance | delete /process-instance/{id} | |
| ProcessInstanceApi | delete_process_instance_variable | delete /process-instance/{id}/variables/{varName} | |
| ProcessInstanceApi | delete_process_instances_async_operation | post /process-instance/delete | |
| ProcessInstanceApi | get_activity_instance_tree | get /process-instance/{id}/activity-instances | |
| ProcessInstanceApi | get_process_instance_variable | get /process-instance/{id}/variables/{varName} | |
| ProcessInstanceApi | get_process_instance_variable_binary | get /process-instance/{id}/variables/{varName}/data | |
| ProcessInstanceApi | get_process_instance_variables | get /process-instance/{id}/variables | |
| ProcessInstanceApi | get_process_instances | get /process-instance | |
| ProcessInstanceApi | get_process_instances_count | get /process-instance/count | |
| ProcessInstanceApi | modify_process_instance | post /process-instance/{id}/modification | |
| ProcessInstanceApi | modify_process_instance_async_operation | post /process-instance/{id}/modification-async | |
| ProcessInstanceApi | modify_process_instance_variables | post /process-instance/{id}/variables | |
| ProcessInstanceApi | query_process_instances | post /process-instance | |
| ProcessInstanceApi | query_process_instances_count | post /process-instance/count | |
| ProcessInstanceApi | set_process_instance_variable | put /process-instance/{id}/variables/{varName} | |
| ProcessInstanceApi | set_process_instance_variable_binary | post /process-instance/{id}/variables/{varName}/data | |
| ProcessInstanceApi | set_retries_by_process | post /process-instance/job-retries | |
| ProcessInstanceApi | set_retries_by_process_historic_query_based | post /process-instance/job-retries-historic-query-based | |
| ProcessInstanceApi | update_suspension_state | put /process-instance/suspended | |
| ProcessInstanceApi | update_suspension_state_async_operation | post /process-instance/suspended-async | |
| ProcessInstanceApi | update_suspension_state_by_id | put /process-instance/{id}/suspended | |
| SchemaLogApi | get_schema_log | get /schema/log | |
| SchemaLogApi | query_schema_log | post /schema/log | |
| SignalApi | throw_signal | post /signal | |
| TaskApi | claim | post /task/{id}/claim | |
| TaskApi | complete | post /task/{id}/complete | |
| TaskApi | create_task | post /task/create | |
| TaskApi | delegate_task | post /task/{id}/delegate | |
| TaskApi | delete_task | delete /task/{id} | |
| TaskApi | get_deployed_form | get /task/{id}/deployed-form | |
| TaskApi | get_form | get /task/{id}/form | |
| TaskApi | get_form_variables | get /task/{id}/form-variables | |
| TaskApi | get_rendered_form | get /task/{id}/rendered-form | |
| TaskApi | get_task | get /task/{id} | |
| TaskApi | get_tasks | get /task | |
| TaskApi | get_tasks_count | get /task/count | |
| TaskApi | handle_bpmn_error | post /task/{id}/bpmnError | |
| TaskApi | handle_escalation | post /task/{id}/bpmnEscalation | |
| TaskApi | query_tasks | post /task | |
| TaskApi | query_tasks_count | post /task/count | |
| TaskApi | resolve | post /task/{id}/resolve | |
| TaskApi | set_assignee | post /task/{id}/assignee | |
| TaskApi | submit | post /task/{id}/submit-form | |
| TaskApi | unclaim | post /task/{id}/unclaim | |
| TaskApi | update_task | put /task/{id} | |
| TaskAttachmentApi | add_attachment | post /task/{id}/attachment/create | |
| TaskAttachmentApi | delete_attachment | delete /task/{id}/attachment/{attachmentId} | |
| TaskAttachmentApi | get_attachment | get /task/{id}/attachment/{attachmentId} | |
| TaskAttachmentApi | get_attachment_data | get /task/{id}/attachment/{attachmentId}/data | |
| TaskAttachmentApi | get_attachments | get /task/{id}/attachment | |
| TaskCommentApi | create_comment | post /task/{id}/comment/create | |
| TaskCommentApi | get_comment | get /task/{id}/comment/{commentId} | |
| TaskCommentApi | get_comments | get /task/{id}/comment | |
| TaskIdentityLinkApi | add_identity_link | post /task/{id}/identity-links | |
| TaskIdentityLinkApi | delete_identity_link | post /task/{id}/identity-links/delete | |
| TaskIdentityLinkApi | get_identity_links | get /task/{id}/identity-links | |
| TaskLocalVariableApi | delete_task_local_variable | delete /task/{id}/localVariables/{varName} | |
| TaskLocalVariableApi | get_task_local_variable | get /task/{id}/localVariables/{varName} | |
| TaskLocalVariableApi | get_task_local_variable_binary | get /task/{id}/localVariables/{varName}/data | |
| TaskLocalVariableApi | get_task_local_variables | get /task/{id}/localVariables | |
| TaskLocalVariableApi | modify_task_local_variables | post /task/{id}/localVariables | |
| TaskLocalVariableApi | put_task_local_variable | put /task/{id}/localVariables/{varName} | |
| TaskLocalVariableApi | set_binary_task_local_variable | post /task/{id}/localVariables/{varName}/data | |
| TaskVariableApi | delete_task_variable | delete /task/{id}/variables/{varName} | |
| TaskVariableApi | get_task_variable | get /task/{id}/variables/{varName} | |
| TaskVariableApi | get_task_variable_binary | get /task/{id}/variables/{varName}/data | |
| TaskVariableApi | get_task_variables | get /task/{id}/variables | |
| TaskVariableApi | modify_task_variables | post /task/{id}/variables | |
| TaskVariableApi | put_task_variable | put /task/{id}/variables/{varName} | |
| TaskVariableApi | set_binary_task_variable | post /task/{id}/variables/{varName}/data | |
| VersionApi | get_rest_api_version | get /version |
To get access to the crate's generated documentation, use:
cargo doc --open