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 | evaluatecondition | post /condition | *DeploymentApi* | createdeployment | post /deployment/create | DeploymentApi | deletedeployment | delete /deployment/{id} | *DeploymentApi* | getdeployment | get /deployment/{id} | DeploymentApi | getdeploymentresource | get /deployment/{id}/resources/{resourceId} | DeploymentApi | getdeploymentresourcedata | get /deployment/{id}/resources/{resourceId}/data | *DeploymentApi* | getdeploymentresources | get /deployment/{id}/resources | *DeploymentApi* | getdeployments | get /deployment | DeploymentApi | getdeploymentscount | get /deployment/count | DeploymentApi | redeploy | post /deployment/{id}/redeploy | EngineApi | getprocessenginenames | get /engine | *EventSubscriptionApi* | geteventsubscriptions | get /event-subscription | *EventSubscriptionApi* | geteventsubscriptionscount | get /event-subscription/count | ExternalTaskApi | completeexternaltaskresource | post /external-task/{id}/complete | *ExternalTaskApi* | extendlock | post /external-task/{id}/extendLock | ExternalTaskApi | fetchandlock | post /external-task/fetchAndLock | ExternalTaskApi | getexternaltask | get /external-task/{id} | ExternalTaskApi | getexternaltaskerrordetails | get /external-task/{id}/errorDetails | ExternalTaskApi | getexternaltasks | get /external-task | ExternalTaskApi | getexternaltaskscount | get /external-task/count | *ExternalTaskApi* | gettopicnames | get /external-task/topic-names | *ExternalTaskApi* | handleexternaltaskbpmnerror | post /external-task/{id}/bpmnError | *ExternalTaskApi* | handlefailure | post /external-task/{id}/failure | ExternalTaskApi | queryexternaltasks | post /external-task | ExternalTaskApi | queryexternaltaskscount | post /external-task/count | *ExternalTaskApi* | setexternaltaskresourcepriority | put /external-task/{id}/priority | *ExternalTaskApi* | setexternaltaskresourceretries | put /external-task/{id}/retries | *ExternalTaskApi* | setexternaltaskretries | put /external-task/retries | ExternalTaskApi | setexternaltaskretriesasyncoperation | post /external-task/retries-async | *ExternalTaskApi* | unlock | post /external-task/{id}/unlock | *MessageApi* | delivermessage | post /message | MetricsApi | getmetrics | get /metrics/{metrics-name}/sum | *MetricsApi* | interval | get /metrics | *ProcessDefinitionApi* | deleteprocessdefinition | delete /process-definition/{id} | Delete *ProcessDefinitionApi* | deleteprocessdefinitionsbykey | delete /process-definition/key/{key} | Delete By Key *ProcessDefinitionApi* | deleteprocessdefinitionsbykeyandtenantid | delete /process-definition/key/{key}/tenant/{tenant-id} | Delete By Key ProcessDefinitionApi | getactivitystatistics | get /process-definition/{id}/statistics | Get Activity Instance Statistics ProcessDefinitionApi | getactivitystatisticsbyprocessdefinitionkey | get /process-definition/key/{key}/statistics | Get Activity Instance Statistics ProcessDefinitionApi | getactivitystatisticsbyprocessdefinitionkeyandtenantid | get /process-definition/key/{key}/tenant/{tenant-id}/statistics | Get Activity Instance Statistics *ProcessDefinitionApi* | getdeployedstartform | get /process-definition/{id}/deployed-start-form | Get Deployed Start Form ProcessDefinitionApi | getdeployedstartformbykey | get /process-definition/key/{key}/deployed-start-form | Get Deployed Start Form *ProcessDefinitionApi* | getdeployedstartformbykeyandtenantid | get /process-definition/key/{key}/tenant/{tenant-id}/deployed-start-form | Get Deployed Start Form *ProcessDefinitionApi* | getlatestprocessdefinitionbytenantid | get /process-definition/key/{key}/tenant/{tenant-id} | Get *ProcessDefinitionApi* | getprocessdefinition | get /process-definition/{id} | Get *ProcessDefinitionApi* | getprocessdefinitionbpmn20xml | get /process-definition/{id}/xml | Get XML *ProcessDefinitionApi* | getprocessdefinitionbpmn20xmlbykey | get /process-definition/key/{key}/xml | Get XML *ProcessDefinitionApi* | getprocessdefinitionbpmn20xmlbykeyandtenantid | get /process-definition/key/{key}/tenant/{tenant-id}/xml | Get XML ProcessDefinitionApi | getprocessdefinitionbykey | get /process-definition/key/{key} | Get ProcessDefinitionApi | getprocessdefinitiondiagram | get /process-definition/{id}/diagram | Get Diagram *ProcessDefinitionApi* | getprocessdefinitiondiagrambykey | get /process-definition/key/{key}/diagram | Get Diagram ProcessDefinitionApi | getprocessdefinitiondiagrambykeyandtenantid | get /process-definition/key/{key}/tenant/{tenant-id}/diagram | Get Diagram ProcessDefinitionApi | getprocessdefinitionstatistics | get /process-definition/statistics | Get Process Instance Statistics *ProcessDefinitionApi* | getprocessdefinitions | get /process-definition | Get List *ProcessDefinitionApi* | getprocessdefinitionscount | get /process-definition/count | Get List Count ProcessDefinitionApi | getrenderedstartform | get /process-definition/{id}/rendered-form | Get Rendered Start Form *ProcessDefinitionApi* | getrenderedstartformbykey | get /process-definition/key/{key}/rendered-form | Get Rendered Start Form ProcessDefinitionApi | getrenderedstartformbykeyandtenantid | get /process-definition/key/{key}/tenant/{tenant-id}/rendered-form | Get Rendered Start Form ProcessDefinitionApi | getstartform | get /process-definition/{id}/startForm | Get Start Form Key ProcessDefinitionApi | getstartformbykey | get /process-definition/key/{key}/startForm | Get Start Form Key ProcessDefinitionApi | getstartformbykeyandtenantid | get /process-definition/key/{key}/tenant/{tenant-id}/startForm | Get Start Form Key *ProcessDefinitionApi* | getstartformvariables | get /process-definition/{id}/form-variables | Get Start Form Variables ProcessDefinitionApi | getstartformvariablesbykey | get /process-definition/key/{key}/form-variables | Get Start Form Variables *ProcessDefinitionApi* | getstartformvariablesbykeyandtenantid | get /process-definition/key/{key}/tenant/{tenant-id}/form-variables | Get Start Form Variables *ProcessDefinitionApi* | restartprocessinstance | post /process-definition/{id}/restart | Restart Process Instance *ProcessDefinitionApi* | restartprocessinstanceasyncoperation | post /process-definition/{id}/restart-async | Restart Process Instance Async *ProcessDefinitionApi* | startprocessinstance | post /process-definition/{id}/start | Start Instance *ProcessDefinitionApi* | startprocessinstancebykey | post /process-definition/key/{key}/start | Start Instance *ProcessDefinitionApi* | startprocessinstancebykeyandtenantid | post /process-definition/key/{key}/tenant/{tenant-id}/start | Start Instance ProcessDefinitionApi | submitform | post /process-definition/{id}/submit-form | Submit Start Form *ProcessDefinitionApi* | submitformbykey | post /process-definition/key/{key}/submit-form | Submit Start Form ProcessDefinitionApi | submitformbykeyandtenantid | post /process-definition/key/{key}/tenant/{tenant-id}/submit-form | Submit Start Form ProcessDefinitionApi | updatehistorytimetolivebyprocessdefinitionid | put /process-definition/{id}/history-time-to-live | Update History Time to Live ProcessDefinitionApi | updatehistorytimetolivebyprocessdefinitionkey | put /process-definition/key/{key}/history-time-to-live | Update History Time to Live ProcessDefinitionApi | updatehistorytimetolivebyprocessdefinitionkeyandtenantid | put /process-definition/key/{key}/tenant/{tenant-id}/history-time-to-live | Update History Time to Live *ProcessDefinitionApi* | updateprocessdefinitionsuspensionstate | put /process-definition/suspended | Activate/Suspend By Key *ProcessDefinitionApi* | updateprocessdefinitionsuspensionstatebyid | put /process-definition/{id}/suspended | Activate/Suspend By Id *ProcessDefinitionApi* | updateprocessdefinitionsuspensionstatebykey | put /process-definition/key/{key}/suspended | Activate/Suspend by Id *ProcessDefinitionApi* | updateprocessdefinitionsuspensionstatebykeyandtenantid | put /process-definition/key/{key}/tenant/{tenant-id}/suspended | Activate/Suspend by Id ProcessInstanceApi | deleteasynchistoricquerybased | post /process-instance/delete-historic-query-based | ProcessInstanceApi | deleteprocessinstance | delete /process-instance/{id} | ProcessInstanceApi | deleteprocessinstancevariable | delete /process-instance/{id}/variables/{varName} | *ProcessInstanceApi* | deleteprocessinstancesasyncoperation | post /process-instance/delete | *ProcessInstanceApi* | getactivityinstancetree | get /process-instance/{id}/activity-instances | ProcessInstanceApi | getprocessinstancevariable | get /process-instance/{id}/variables/{varName} | *ProcessInstanceApi* | getprocessinstancevariablebinary | get /process-instance/{id}/variables/{varName}/data | *ProcessInstanceApi* | getprocessinstancevariables | get /process-instance/{id}/variables | ProcessInstanceApi | getprocessinstances | get /process-instance | ProcessInstanceApi | getprocessinstancescount | get /process-instance/count | *ProcessInstanceApi* | modifyprocessinstance | post /process-instance/{id}/modification | *ProcessInstanceApi* | modifyprocessinstanceasyncoperation | post /process-instance/{id}/modification-async | *ProcessInstanceApi* | modifyprocessinstancevariables | post /process-instance/{id}/variables | ProcessInstanceApi | queryprocessinstances | post /process-instance | ProcessInstanceApi | queryprocessinstancescount | post /process-instance/count | *ProcessInstanceApi* | setprocessinstancevariable | put /process-instance/{id}/variables/{varName} | ProcessInstanceApi | setprocessinstancevariablebinary | post /process-instance/{id}/variables/{varName}/data | ProcessInstanceApi | setretriesbyprocess | post /process-instance/job-retries | *ProcessInstanceApi* | setretriesbyprocesshistoricquerybased | post /process-instance/job-retries-historic-query-based | *ProcessInstanceApi* | updatesuspensionstate | put /process-instance/suspended | *ProcessInstanceApi* | updatesuspensionstateasyncoperation | post /process-instance/suspended-async | *ProcessInstanceApi* | updatesuspensionstatebyid | put /process-instance/{id}/suspended | *SchemaLogApi* | getschemalog | get /schema/log | *SchemaLogApi* | queryschemalog | post /schema/log | *SignalApi* | throwsignal | post /signal | TaskApi | claim | post /task/{id}/claim | TaskApi | complete | post /task/{id}/complete | TaskApi | createtask | post /task/create | *TaskApi* | delegatetask | post /task/{id}/delegate | TaskApi | deletetask | delete /task/{id} | *TaskApi* | getdeployedform | get /task/{id}/deployed-form | *TaskApi* | getform | get /task/{id}/form | TaskApi | getformvariables | get /task/{id}/form-variables | TaskApi | getrenderedform | get /task/{id}/rendered-form | TaskApi | gettask | get /task/{id} | *TaskApi* | gettasks | get /task | TaskApi | gettaskscount | get /task/count | TaskApi | handlebpmnerror | post /task/{id}/bpmnError | TaskApi | handleescalation | post /task/{id}/bpmnEscalation | *TaskApi* | querytasks | post /task | TaskApi | querytaskscount | post /task/count | TaskApi | resolve | post /task/{id}/resolve | TaskApi | setassignee | post /task/{id}/assignee | *TaskApi* | submit | post /task/{id}/submit-form | *TaskApi* | unclaim | post /task/{id}/unclaim | *TaskApi* | updatetask | put /task/{id} | TaskAttachmentApi | addattachment | post /task/{id}/attachment/create | *TaskAttachmentApi* | deleteattachment | delete /task/{id}/attachment/{attachmentId} | TaskAttachmentApi | getattachment | get /task/{id}/attachment/{attachmentId} | *TaskAttachmentApi* | getattachmentdata | get /task/{id}/attachment/{attachmentId}/data | *TaskAttachmentApi* | getattachments | get /task/{id}/attachment | TaskCommentApi | createcomment | post /task/{id}/comment/create | *TaskCommentApi* | getcomment | get /task/{id}/comment/{commentId} | TaskCommentApi | getcomments | get /task/{id}/comment | *TaskIdentityLinkApi* | addidentitylink | post /task/{id}/identity-links | *TaskIdentityLinkApi* | deleteidentitylink | post /task/{id}/identity-links/delete | *TaskIdentityLinkApi* | getidentitylinks | get /task/{id}/identity-links | *TaskLocalVariableApi* | deletetasklocalvariable | delete /task/{id}/localVariables/{varName} | TaskLocalVariableApi | gettasklocalvariable | get /task/{id}/localVariables/{varName} | *TaskLocalVariableApi* | gettasklocalvariablebinary | get /task/{id}/localVariables/{varName}/data | *TaskLocalVariableApi* | gettasklocalvariables | get /task/{id}/localVariables | TaskLocalVariableApi | modifytasklocalvariables | post /task/{id}/localVariables | *TaskLocalVariableApi* | puttasklocalvariable | put /task/{id}/localVariables/{varName} | TaskLocalVariableApi | setbinarytasklocalvariable | post /task/{id}/localVariables/{varName}/data | TaskVariableApi | deletetaskvariable | delete /task/{id}/variables/{varName} | TaskVariableApi | gettaskvariable | get /task/{id}/variables/{varName} | TaskVariableApi | gettaskvariablebinary | get /task/{id}/variables/{varName}/data | *TaskVariableApi* | gettaskvariables | get /task/{id}/variables | *TaskVariableApi* | modifytaskvariables | post /task/{id}/variables | *TaskVariableApi* | puttaskvariable | put /task/{id}/variables/{varName} | *TaskVariableApi* | setbinarytaskvariable | post /task/{id}/variables/{varName}/data | VersionApi | getrestapi_version | get /version |
To get access to the crate's generated documentation, use:
cargo doc --open