Lib.rs

›
#rest #camunda #client #version #documentation #api-client #open-api

camunda-client

Rust 版 camunda Rest API 客户端

由 Dan Amoroso，OpenAPI Generator 团队和贡献者创建

3 个版本

使用旧的 Rust 2015

0.1.2 2021 年 4 月 22 日
0.1.1 2021 年 4 月 12 日
0.1.0 2020 年 9 月 28 日

#99 in #rest


在 camunda-worker 中使用

Apache-2.0

550KB
8K SLoC

Rust API 客户端用于 openapi

Camunda BPM REST API 的 OpenApi 规范。

概述

此 API 客户端由 OpenAPI Generator 项目生成。通过使用远程服务器的 openapi-spec，您可以轻松生成 API 客户端。

  • API 版本：7.13.0
  • 包版本：1.0.0
  • 构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放在您的项目文件夹中，并在 Cargo.toml 中的 [dependencies] 下添加以下内容

    openapi = { path = "./generated" }

API 端点文档

所有 URI 都相对于 https://127.0.0.1:8080/engine-rest

类 方法 HTTP 请求 描述
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 设置外部任务资源优先级 put /external-task/{id}/priority
ExternalTaskApi 设置外部任务资源重试次数 put /external-task/{id}/retries
ExternalTaskApi 设置外部任务重试次数 put /external-task/retries
ExternalTaskApi 设置外部任务异步操作重试次数 post /external-task/retries-async
ExternalTaskApi 解锁 post /external-task/{id}/unlock
MessageApi 投递消息 post /message
MetricsApi 获取指标 get /metrics/{metrics-name}/sum
MetricsApi 间隔 get /metrics
ProcessDefinitionApi 删除流程定义 delete /process-definition/{id} 删除
ProcessDefinitionApi 通过键删除流程定义 delete /process-definition/key/{key} 通过键删除
ProcessDefinitionApi 通过键和租户ID删除流程定义 delete /process-definition/key/{key}/tenant/{tenant-id} 通过键删除
ProcessDefinitionApi 获取活动统计信息 get /process-definition/{id}/statistics 获取活动实例统计信息
ProcessDefinitionApi 通过流程定义键获取活动统计信息 get /process-definition/key/{key}/statistics 获取活动实例统计信息
ProcessDefinitionApi 通过流程定义键和租户ID获取活动统计信息 get /process-definition/key/{key}/tenant/{tenant-id}/statistics 获取活动实例统计信息
ProcessDefinitionApi 获取部署的起始表单 get /process-definition/{id}/deployed-start-form 获取部署的起始表单
ProcessDefinitionApi 通过键获取部署的起始表单 get /process-definition/key/{key}/deployed-start-form 获取部署的起始表单
ProcessDefinitionApi 通过键和租户ID获取部署的起始表单 get /process-definition/key/{key}/tenant/{tenant-id}/deployed-start-form 获取部署的起始表单
ProcessDefinitionApi 通过租户ID获取最新的流程定义 get /process-definition/key/{key}/tenant/{tenant-id} 获取
ProcessDefinitionApi 获取流程定义 get /process-definition/{id} 获取
ProcessDefinitionApi 获取流程定义的BPMN20 XML get /process-definition/{id}/xml 获取XML
ProcessDefinitionApi 通过键获取流程定义的BPMN20 XML get /process-definition/key/{key}/xml 获取XML
ProcessDefinitionApi 通过键和租户ID获取流程定义的BPMN20 XML get /process-definition/key/{key}/tenant/{tenant-id}/xml 获取XML
ProcessDefinitionApi 通过键获取流程定义 get /process-definition/key/{key} 获取
ProcessDefinitionApi 获取流程定义图 get /process-definition/{id}/diagram 获取图
ProcessDefinitionApi 通过键获取流程定义图 get /process-definition/key/{key}/diagram 获取图
ProcessDefinitionApi 通过键和租户ID获取流程定义图 get /process-definition/key/{key}/tenant/{tenant-id}/diagram 获取图
ProcessDefinitionApi 获取流程定义统计信息 get /process-definition/statistics 获取流程实例统计信息
ProcessDefinitionApi 获取流程定义列表 get /process-definition 获取列表
ProcessDefinitionApi 获取流程定义数量 get /process-definition/count 获取列表数量
ProcessDefinitionApi 获取渲染的起始表单 get /process-definition/{id}/rendered-form 获取渲染的起始表单
ProcessDefinitionApi 通过键获取渲染的起始表单 get /process-definition/key/{key}/rendered-form 获取渲染的起始表单
ProcessDefinitionApi 通过键和租户ID获取渲染的起始表单 get /process-definition/key/{key}/tenant/{tenant-id}/rendered-form 获取渲染的起始表单
ProcessDefinitionApi 获取起始表单 get /process-definition/{id}/startForm 获取起始表单键
ProcessDefinitionApi 通过键获取起始表单 get /process-definition/key/{key}/startForm 获取起始表单键
ProcessDefinitionApi 通过键和租户ID获取起始表单 get /process-definition/key/{key}/tenant/{tenant-id}/startForm 获取起始表单键
ProcessDefinitionApi 获取起始表单变量 get /process-definition/{id}/form-variables 获取起始表单变量
ProcessDefinitionApi 通过键获取起始表单变量 get /process-definition/key/{key}/form-variables 获取起始表单变量
ProcessDefinitionApi 通过键和租户ID获取起始表单变量 get /process-definition/key/{key}/tenant/{tenant-id}/form-variables 获取起始表单变量
ProcessDefinitionApi 重启流程实例 post /process-definition/{id}/restart 重启流程实例
ProcessDefinitionApi 异步重启流程实例 post /process-definition/{id}/restart-async 异步重启流程实例
ProcessDefinitionApi 启动流程实例 post /process-definition/{id}/start 启动实例
ProcessDefinitionApi 通过键启动流程实例 post /process-definition/key/{key}/start 启动实例
ProcessDefinitionApi 通过键和租户ID启动流程实例 post /process-definition/key/{key}/tenant/{tenant-id}/start 启动实例
ProcessDefinitionApi 提交表单 post /process-definition/{id}/submit-form 提交起始表单
ProcessDefinitionApi 通过键提交表单 post /process-definition/key/{key}/submit-form 提交起始表单
ProcessDefinitionApi 通过键和租户ID提交表单 post /process-definition/key/{key}/tenant/{tenant-id}/submit-form 提交起始表单
ProcessDefinitionApi 通过流程定义ID更新历史时间到活 put /process-definition/{id}/history-time-to-live 更新历史时间到活
ProcessDefinitionApi 通过流程定义键更新历史时间到活 put /process-definition/key/{key}/history-time-to-live 更新历史时间到活
ProcessDefinitionApi 通过流程定义键和租户ID更新历史时间到活 put /process-definition/key/{key}/tenant/{tenant-id}/history-time-to-live 更新历史时间到活
ProcessDefinitionApi 更新流程定义挂起状态 put /process-definition/suspended 通过键激活/挂起
ProcessDefinitionApi 通过ID更新流程定义挂起状态 put /process-definition/{id}/suspended 通过ID激活/挂起
ProcessDefinitionApi 通过键更新流程定义挂起状态 put /process-definition/key/{key}/suspended 通过ID激活/挂起
ProcessDefinitionApi 通过键和租户ID更新流程定义挂起状态 put /process-definition/key/{key}/tenant/{tenant-id}/suspended 通过ID激活/挂起
ProcessInstanceApi 基于历史查询异步删除 post /process-instance/delete-historic-query-based
ProcessInstanceApi 删除流程实例 delete /process-instance/{id}
ProcessInstanceApi 删除流程实例变量 delete /process-instance/{id}/variables/{varName}
ProcessInstanceApi 删除流程实例异步操作 post /process-instance/delete
ProcessInstanceApi 获取活动实例树 get /process-instance/{id}/activity-instances
ProcessInstanceApi 获取流程实例变量 get /process-instance/{id}/variables/{varName}
ProcessInstanceApi 获取流程实例变量二进制 get /process-instance/{id}/variables/{varName}/data
ProcessInstanceApi 获取流程实例变量 get /process-instance/{id}/variables
ProcessInstanceApi 获取流程实例 get /process-instance
ProcessInstanceApi 获取流程实例计数 get /process-instance/count
ProcessInstanceApi 修改流程实例 post /process-instance/{id}/modification
ProcessInstanceApi 修改流程实例异步操作 post /process-instance/{id}/modification-async
ProcessInstanceApi 修改流程实例变量 post /process-instance/{id}/variables
ProcessInstanceApi 查询流程实例 post /process-instance
ProcessInstanceApi 查询流程实例计数 post /process-instance/count
ProcessInstanceApi 设置流程实例变量 put /process-instance/{id}/variables/{varName}
ProcessInstanceApi 设置流程实例变量二进制 post /process-instance/{id}/variables/{varName}/data
ProcessInstanceApi 通过流程设置重试次数 post /process-instance/job-retries
ProcessInstanceApi 通过流程基于历史查询设置重试次数 post /process-instance/job-retries-historic-query-based
ProcessInstanceApi 更新挂起状态 put /process-instance/suspended
ProcessInstanceApi 更新挂起状态异步操作 post /process-instance/suspended-async
ProcessInstanceApi 通过ID更新挂起状态 put /process-instance/{id}/suspended
SchemaLogApi 获取模式日志 get /schema/log
SchemaLogApi 查询模式日志 post /schema/log
SignalApi 抛出信号 post /signal
TaskApi 认领 post /task/{id}/claim
TaskApi 完成 post /task/{id}/complete
TaskApi 创建任务 post /task/create
TaskApi 委派任务 post /task/{id}/delegate
TaskApi 删除任务 delete /task/{id}
TaskApi 获取部署表单 get /task/{id}/deployed-form
TaskApi 获取表单 get /task/{id}/form
TaskApi 获取表单变量 get /task/{id}/form-variables
TaskApi 获取渲染表单 get /task/{id}/rendered-form
TaskApi 获取任务 get /task/{id}
TaskApi 获取任务 get /task
TaskApi 获取任务计数 get /task/count
TaskApi 处理BPMN错误 post /task/{id}/bpmnError
TaskApi 处理升级 post /task/{id}/bpmnEscalation
TaskApi 查询任务 post /task
TaskApi 查询任务计数 post /task/count
TaskApi 解决 post /task/{id}/resolve
TaskApi 设置分配人 post /task/{id}/assignee
TaskApi 提交 post /task/{id}/submit-form
TaskApi 放弃认领 post /task/{id}/unclaim
TaskApi 更新任务 put /task/{id}
TaskAttachmentApi 添加附件 post /task/{id}/attachment/create
TaskAttachmentApi 删除附件 删除 /task/{id}/attachment/{attachmentId}
TaskAttachmentApi 获取附件 获取 /task/{id}/attachment/{attachmentId}
TaskAttachmentApi 获取附件数据 获取 /task/{id}/attachment/{attachmentId}/data
TaskAttachmentApi 获取所有附件 获取 /task/{id}/attachment
TaskCommentApi 创建评论 POST /task/{id}/comment/create
TaskCommentApi 获取评论 获取 /task/{id}/comment/{commentId}
TaskCommentApi 获取所有评论 获取 /task/{id}/comment
TaskIdentityLinkApi 添加身份链接 POST /task/{id}/identity-links
TaskIdentityLinkApi 删除身份链接 POST /task/{id}/identity-links/delete
TaskIdentityLinkApi 获取所有身份链接 获取 /task/{id}/identity-links
TaskLocalVariableApi 删除任务本地变量 删除 /task/{id}/localVariables/{varName}
TaskLocalVariableApi 获取任务本地变量 获取 /task/{id}/localVariables/{varName}
TaskLocalVariableApi 获取任务本地变量二进制数据 获取 /task/{id}/localVariables/{varName}/data
TaskLocalVariableApi 获取所有任务本地变量 获取 /task/{id}/localVariables
TaskLocalVariableApi 修改任务本地变量 POST /task/{id}/localVariables
TaskLocalVariableApi 更新任务本地变量 PUT /task/{id}/localVariables/{varName}
TaskLocalVariableApi 设置二进制任务本地变量 POST /task/{id}/localVariables/{varName}/data
TaskVariableApi 删除任务变量 删除 /task/{id}/variables/{varName}
TaskVariableApi 获取任务变量 获取 /task/{id}/variables/{varName}
TaskVariableApi 获取任务变量二进制数据 获取 /task/{id}/variables/{varName}/data
TaskVariableApi 获取所有任务变量 获取 /task/{id}/variables
TaskVariableApi 修改任务变量 POST /task/{id}/variables
TaskVariableApi 更新任务变量 PUT /task/{id}/variables/{varName}
TaskVariableApi 设置二进制任务变量 POST /task/{id}/variables/{varName}/data
VersionApi 获取REST API版本 获取 /version

模型文档说明

要获取 crate 生成的文档，请使用

cargo doc --open

作者

依赖项

~19MB
~424K SLoC