# 工作日历管理接口 MgrBizCalendar
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-calendar/can-insert | 是否可以新增 |
| /bps/mgr/biz-calendar/delete-biz-calendar | 删除工作日历 |
| /bps/mgr/biz-calendar/delete-biz-calendars | 删除工作日历 |
| /bps/mgr/biz-calendar/expand-biz-calendar | 查询一条工作日历 |
| /bps/mgr/biz-calendar/query-biz-calendar | 查询符合条件的工作日历 |
| /bps/mgr/biz-calendar/query-biz-calendar-details-by-month | 查询日历明细 |
| /bps/mgr/biz-calendar/save-biz-calendar | 保存日历 |
| /bps/mgr/biz-calendar/save-biz-calendar-detail | 保存日历明细 |
# 参与者日历相关接口 MgrBizCaleparti
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-caleparti/can-insert | 是否可以新增参与者日历 |
| /bps/mgr/biz-caleparti/delete-biz-caleparti | 删除一个参与者日历 |
| /bps/mgr/biz-caleparti/expand-biz-caleparti | 根据条件查询参与者日历详情 |
| /bps/mgr/biz-caleparti/query-biz-caleparties-1 | 根据条件查询日历 |
| /bps/mgr/biz-caleparti/query-biz-caleparties-2 | 根据条件分页查询日历 |
| /bps/mgr/biz-caleparti/save-biz-caleparti | 保存参与者日历 |
# 业务目录权限接口 MgrBizCatalog4Perm
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-catalog-4-perm/expand-catalog-info-4-perm | 查询一条业务目录，包含权限信息 |
| /bps/mgr/biz-catalog-4-perm/get-all-catalog-perm-by-parti | 根据参与者ID和类型，权限类型，获取所有业务目录权限 |
| /bps/mgr/biz-catalog-4-perm/get-all-catalog-perm-by-user-id | 根据用户ID，获取所有业务目录权限 |
| /bps/mgr/biz-catalog-4-perm/get-all-sub-catalog-by-user-id | 根据用户ID、权限类型、父目录ID查找所有子业务目录 |
| /bps/mgr/biz-catalog-4-perm/get-catalog-root-by-user-id | 根据用户ID和权限类型查找根业务目录 |
| /bps/mgr/biz-catalog-4-perm/get-catalog-sub-by-user-id | 根据用户ID、权限类型、父目录ID查找子业务目录 |
# 维护业务目录的实现类接口 MgrBizCatalog
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-catalog/can-delete | 业务目录是否可以被删除 |
| /bps/mgr/biz-catalog/can-insert | 是否可以新增 |
| /bps/mgr/biz-catalog/delete-catalog-info | 删除业务目录 |
| /bps/mgr/biz-catalog/expand-catalog-info | 查询一条业务目录 |
| /bps/mgr/biz-catalog/get-catalog-path-name-by-id | 根据业务目录ID获取业务目录全路径 |
| /bps/mgr/biz-catalog/get-useable-biz-resources-by-cur-cid | 根据当前业务目录ID获取其所有父级的资源和全局资源(定义表的) |
| /bps/mgr/biz-catalog/query-biz-resource-by-catalog-id | 根据业务目录ID获取目录级业务资源(定义表的) |
| /bps/mgr/biz-catalog/query-catalog-infos | 查询符合条件的业务目录 |
| /bps/mgr/biz-catalog/save-catalog-info | 保存业务目录 |
| /bps/mgr/biz-catalog/save-catalog-perms | 保存业务目录关系 |
| /bps/mgr/biz-catalog/save-catalogs | 保存业务目录 |
# 通用资源管理接口 MgrBizCommResource
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-comm-resource/save-comm-biz-resources | 保存业务资源 |
# 人工任务管理接口 MgrBizHumantask
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-humantask/can-insert | 是否可以新增 |
| /bps/mgr/biz-humantask/copy-resource | 复制业务资源到目标位置 |
| /bps/mgr/biz-humantask/delete-biz-humantask | 删除业务操作 |
| /bps/mgr/biz-humantask/delete-biz-humantasks | 删除业务操作 |
| /bps/mgr/biz-humantask/expand-biz-humantask | 查询一条业务操作 |
| /bps/mgr/biz-humantask/expand-biz-humantask-inst | 查询一条业务操作 |
| /bps/mgr/biz-humantask/get-references | 获取业务资源的引用 |
| /bps/mgr/biz-humantask/is-exist-references | 是否存在业务资源的引用 |
| /bps/mgr/biz-humantask/move-resource | 移动业务资源到目标位置 |
| /bps/mgr/biz-humantask/query-biz-humantasks | 查询符合条件的业务操作 |
| /bps/mgr/biz-humantask/save-biz-humantask | 保存业务操作 |
# 业务映射接口 MgrBizMapper
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-mapper/delete-table | 删除业务映射表 |
| /bps/mgr/biz-mapper/query-table-data | 查询业务映射表数据 |
| /bps/mgr/biz-mapper/query-tables | 查询业务映射表 |
| /bps/mgr/biz-mapper/save-table | 保存业务映射表 |
# 维护业务操作的实现类接口 MgrBizOperation
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-operation/can-insert | 是否可以新增 |
| /bps/mgr/biz-operation/copy-resource | 复制业务资源到目标位置 |
| /bps/mgr/biz-operation/delete-biz-operation | 删除业务操作 |
| /bps/mgr/biz-operation/delete-biz-operations | 删除业务操作 |
| /bps/mgr/biz-operation/expand-biz-operation | 查询一条业务操作 |
| /bps/mgr/biz-operation/expand-biz-operation-inst | 查询一条业务操作 |
| /bps/mgr/biz-operation/get-references | 获取业务资源的引用 |
| /bps/mgr/biz-operation/is-exist-references | 是否存在业务资源的引用 |
| /bps/mgr/biz-operation/move-resource | 移动业务资源到目标位置 |
| /bps/mgr/biz-operation/query-biz-operations | 查询符合条件的业务操作 |
| /bps/mgr/biz-operation/query-biz-opers-by-names | 根据业务操作名称列表获取业务操作列表 |
| /bps/mgr/biz-operation/save-biz-operation | 保存业务操作 |
# 业务流程操作相关接口 MgrBizProcess
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-process/can-insert | 是否可以新增业务流程 |
| /bps/mgr/biz-process/copy-biz-process | 复制流程 |
| /bps/mgr/biz-process/delete-biz-process-def | 删除流程定义 |
| /bps/mgr/biz-process/expand-biz-process | 根据流程定义查询流程定义详情 |
| /bps/mgr/biz-process/get-biz-process-by-catalog | 查询指定业务目录下的流程定义 |
| /bps/mgr/biz-process/get-biz-process-string-by-id | 根据流程定义ID获取流程大字段 |
| /bps/mgr/biz-process/get-biz-processs-ch-name-by-name | 根据流程名称查询流程中文名称 |
| /bps/mgr/biz-process/get-sub-biz-processes-by-pid | 根据流程定义获取可用的子流程 |
| /bps/mgr/biz-process/query-activities-of-biz-process | 根据流程ID查询活动 |
| /bps/mgr/biz-process/query-activity-sub-biz-process-def-name | 根据流程ID和活动ID查询子流程名称 |
| /bps/mgr/biz-process/query-biz-process-by-name | 通过业务流程名称查询对应该名称的业务流程 |
| /bps/mgr/biz-process/query-biz-process-defs | 查询符合条件的业务流程 |
| /bps/mgr/biz-process/save-biz-process-def | 保存流程定义 |
| /bps/mgr/biz-process/submit-biz-process | 提交流程 |
| /bps/mgr/biz-process/validate-biz-process | 验证流程 |
# 业务规则管理接口 MgrBizRule
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-rule/can-insert | 是否可以新增 |
| /bps/mgr/biz-rule/copy-resource | 复制业务资源到目标位置 |
| /bps/mgr/biz-rule/delete-biz-rule | 删除业务规则 |
| /bps/mgr/biz-rule/delete-biz-rules | 删除业务规则 |
| /bps/mgr/biz-rule/expand-biz-rule | 查询一条业务规则 |
| /bps/mgr/biz-rule/expand-biz-rule-inst | 查询一条业务规则 |
| /bps/mgr/biz-rule/get-references | 获取业务资源的引用 |
| /bps/mgr/biz-rule/is-exist-references | 是否存在业务资源的引用 |
| /bps/mgr/biz-rule/load-rule-info-clob | 获取业务规则大字段 |
| /bps/mgr/biz-rule/move-resource | 移动业务资源到目标位置 |
| /bps/mgr/biz-rule/query-biz-rule | 查询符合条件的业务规则 |
| /bps/mgr/biz-rule/query-biz-rules-by-process-def-id | 根据流程定义ID获取目录级业务规则（包含父类） |
| /bps/mgr/biz-rule/save-biz-rule | 保存业务规则 |
| /bps/mgr/biz-rule/update-rule-info-clob | 更新业务规则大字段 |
| /bps/mgr/biz-rule/validate | 规则校验 |
# 业务资源、流程提交、提取、部署相关处理接口 MgrBizUnitDeploy
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-unit-deploy/can-pickup-biz-resources | 提取指定的业务资源 |
| /bps/mgr/biz-unit-deploy/deploy-biz-catalog | 部署一个业务目录 |
| /bps/mgr/biz-unit-deploy/deploy-biz-resource | 部署一个业务资源 |
| /bps/mgr/biz-unit-deploy/get-biz-processes-by-proc-name | 根据流程定义名称在运行表中查询所有流程信息 |
| /bps/mgr/biz-unit-deploy/get-biz-resorce-content | 根据资源的UUID和类型获取资源的内容 |
| /bps/mgr/biz-unit-deploy/get-biz-resource-by-proc-name-version | 根据流程定义名称和版本号，获取流程所引用的业务资源列表 |
| /bps/mgr/biz-unit-deploy/get-biz-resources-by-catalog-id | 根据业务目录ID获取业务资源 |
| /bps/mgr/biz-unit-deploy/pickup-biz-process | 提取指定业务流程和指定的业务资源 |
| /bps/mgr/biz-unit-deploy/pickup-biz-resource | 提取指定的业务资源 |
| /bps/mgr/biz-unit-deploy/pickup-biz-resources | 提取指定的业务资源 |
| /bps/mgr/biz-unit-deploy/putin-biz-process | 提交指定业务流程和指定的业务资源 |
| /bps/mgr/biz-unit-deploy/putin-biz-resource | 提交指定的业务资源 |
| /bps/mgr/biz-unit-deploy/putin-biz-resources | 提交指定的业务资源 |
# 业务变量管理接口 MgrBizVar
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/biz-var/can-insert | 是否可以新增 |
| /bps/mgr/biz-var/copy-resource | 复制业务资源到目标位置 |
| /bps/mgr/biz-var/delete-biz-var | 删除业务变量 |
| /bps/mgr/biz-var/delete-biz-vars | 删除业务变量 |
| /bps/mgr/biz-var/expand-biz-var | 查询一条业务变量 |
| /bps/mgr/biz-var/expand-biz-var-inst | 查询一条业务变量 |
| /bps/mgr/biz-var/get-references | 获取业务资源的引用 |
| /bps/mgr/biz-var/is-exist-references | 是否存在业务资源的引用 |
| /bps/mgr/biz-var/move-resource | 移动业务资源到目标位置 |
| /bps/mgr/biz-var/query-biz-var | 查询符合条件的业务变量 |
| /bps/mgr/biz-var/query-biz-vars-by-names | 根据业务变量名称列表获取业务变量列表 |
| /bps/mgr/biz-var/query-biz-vars-by-process-def-id | 根据流程定义ID获取目录级业务变量（包含父类） |
| /bps/mgr/biz-var/save-biz-var | 保存业务变量 |
# 集群管理接口 MgrCluster
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/cluster/is-cluster-enabled | 是否集群 |
| /bps/mgr/cluster/is-engine-started | 判断引擎是否启动 |
| /bps/mgr/cluster/refresh-member-manager-list | 刷新集群成员列表 |
# 通用远程接口 MgrCommonRemote
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/common-remote/call | 调用接口 |
# 租户认证接口 MgrIdentityAuthentication
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/identity-authentication/get-tenant-identity-token | 查询租户令牌 |
| /bps/mgr/identity-authentication/verify-tenant | 校验租户令牌是否合法 |
# BPS模型管理接口 MgrModel
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/model/connect | 建立连接 |
| /bps/mgr/model/delete-process | 数据库服务器中删除一个业务流程。如果该业务流程已经有流程实例存在，则禁止删除，并返回错误信息 |
| /bps/mgr/model/deploy-business-catalog | 部署业务目录 |
| /bps/mgr/model/deploy-business-resource | 部署业务资源 |
| /bps/mgr/model/deploy-process | 部署流程 |
| /bps/mgr/model/disconnect | 断开连接 |
| /bps/mgr/model/get-business-catalog-by-id | 获取下级业务目录 |
| /bps/mgr/model/get-business-resource-content | 根据ID和类型获取资源定义字符串 |
| /bps/mgr/model/get-participant-node | 获取某个节点下的所有参与者 |
| /bps/mgr/model/get-participant-tree | 获取整个参与者树 |
| /bps/mgr/model/get-process-define-content | 获取某版本的流程 |
| /bps/mgr/model/get-root-business-catalog-list | 获取根业务目录列表 |
| /bps/mgr/model/get-sub-business-catalog-list | 获取下级业务目录 |
| /bps/mgr/model/get-version-list-of-process | 获取某流程的版本列表，按照版本顺序排列，最新的版本放在最前面 |
| /bps/mgr/model/retrieve-process-reference-by-catalog-id | 根据业务目录查询关联流程 |
| /bps/mgr/model/retrieve-resource-reference-by-catalog-id | 根据业务目录下资源 |
| /bps/mgr/model/retrieve-resource-reference-by-process-name | 根据流程获取相关资源 |
# 多租户接口 MgrMultiTenancy
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/multi-tenancy/createt-tenant | 创建租户 |
| /bps/mgr/multi-tenancy/delete-tenant-by-id | 删除租户信息 |
| /bps/mgr/multi-tenancy/get-tenant-identity-token | 查询租户令牌 |
| /bps/mgr/multi-tenancy/query-all-external-tenants | 查询所有扩展租户信息 |
| /bps/mgr/multi-tenancy/query-all-tenant-ids | 查询所有租户ID列表 |
| /bps/mgr/multi-tenancy/query-all-tenants | 查询所有租户信息 |
| /bps/mgr/multi-tenancy/query-tenant-by-id | 查询租户信息 |
| /bps/mgr/multi-tenancy/update-tenant-by-id | 修改租户信息 |
# BPS 产品形态信息管理接口 MgrProductInfo
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/product-info/get-product-info | 获取产品信息 |
| /bps/mgr/product-info/get-product-name | BPS产品名称 |
| /bps/mgr/product-info/get-product-version | BPS产品版本 |
# WorkSpace管理相关接口 MgrWs
| 接口URL | 接口名称 |
|---|---|
| /bps/mgr/ws/collect-current-month-data | etl 在本月的任何时期收集本月的数据（手动统计） |
| /bps/mgr/ws/collect-fact-data | etl 收集默认的事实表数据，即上一月数据 |
| /bps/mgr/ws/collect-history-data | etl 初始化历史数据（从传入年1月份开始至当前日期） |
| /bps/mgr/ws/collect-one-month-data | 收集任一月数据 |
| /bps/mgr/ws/count-process-define | 统计业务流程下的版本数 |
| /bps/mgr/ws/enable-b-p-s-catalog-permission | 是否开启业务目录权限开关 |
| /bps/mgr/ws/execute-m-d-x-query | 多维查询操作 |
| /bps/mgr/ws/get-delegate-process-log | 获取代理代办相关操作日志 |
| /bps/mgr/ws/get-etl-email | 以逻辑流的方式返回etl Email 收件人 |
| /bps/mgr/ws/get-form-field-by-activity-inst-id | 根据活动实例ID获取表单对象 |
| /bps/mgr/ws/get-form-field-by-work-item-id | 根据工作项ID获取表单对象 |
| /bps/mgr/ws/get-form-field-model-by-work-item-id | getFormFieldModelByWorkItemId |
| /bps/mgr/ws/get-is-open-procedure | 以逻辑流的方式返回是否开启存储过程 |
| /bps/mgr/ws/get-last-version-sign | 获得业务流程的最新版本号 |
| /bps/mgr/ws/get-process-definition-string | 查询流程定义 |
| /bps/mgr/ws/get-process-formfields | 获取启动表单对象 |
| /bps/mgr/ws/get-process-formfields-model | 获取启动表单对象 |
| /bps/mgr/ws/get-process-ref-biz-vars | 根据流程定义ID，取出流程引用的业务变量 |
| /bps/mgr/ws/get-published-version-sign | 获得业务流程的发布版本号 |
| /bps/mgr/ws/get-rela-data-string | 获取RelaDataString |
| /bps/mgr/ws/get-system-info | 取得系统信息 |
| /bps/mgr/ws/get-transport-result | 获取转历史结果 |
| /bps/mgr/ws/get-w-f-link-color-config-model | 获取流程图连线配置信息 |
| /bps/mgr/ws/get-w-f-process | 通过业务流程ID获取流程定义对象 |
| /bps/mgr/ws/has-biz-form-customize-module | 是否包含业务表单定制模块 |
| /bps/mgr/ws/has-biz-process-customize-module | 是否包含业务流程定制模块 |
| /bps/mgr/ws/has-biz-process-statistics-module | 是否包含流程统计分析模块 |
| /bps/mgr/ws/is-embedded-server | 是否嵌入式Server |
| /bps/mgr/ws/is-init-history-data | 是否初始化过历史数据 |
| /bps/mgr/ws/is-multi-tenant-mode | 是否多租户模式 |
| /bps/mgr/ws/list-package-files-in-working-dir | 列出当前应用的工作目录下，一个构件包中某个package中的所有指定类型的文件绝对路径列表 |
| /bps/mgr/ws/list-packages-in-working | 列出当前应用的工作目录中某个构件包中所有的指定类型文件的package（包含flow，biz等文件的） |
| /bps/mgr/ws/query-activity-timeout-detail | 查询活动超时详细信息 |
| /bps/mgr/ws/query-process-catalogs-bybiz-catalog-id | 获得一个构建包下的所有业务流程目录 |
| /bps/mgr/ws/query-process-inst-view-object | 查询流程实例View对象 |
| /bps/mgr/ws/query-process-timeout-detail | 查询流程超时详细信息 |
| /bps/mgr/ws/query-process-view-object | 根据流程名称查询流程View对象 |
| /bps/mgr/ws/query-process-view-object-1 | 查询流程View对象 |
| /bps/mgr/ws/query-process-view-object-temp | 查询临时库流程View对象 |
| /bps/mgr/ws/query-processes-by-biz-catalog-uuid | 查询某业务目录下的所有业务流程（最新版本） |
| /bps/mgr/ws/read-elt-config-model | 读取数据统计模型信息 |
| /bps/mgr/ws/save-etl-email | 用逻辑流的方式保存etl Email 收件人 |
| /bps/mgr/ws/save-is-open-procedure | 用逻辑流的方式保存是否开启存储过程 |
| /bps/mgr/ws/save-process | 保存流程定义 |
| /bps/mgr/ws/set-un-lock | 手工强制解锁 |
| /bps/mgr/ws/start-transport | 启动转历史 |
| /bps/mgr/ws/validate-connection | 根据租户绑定的数据源测试连接 |
| /bps/mgr/ws/validate-process-string | 校验流程定义 |
| /bps/mgr/ws/write-elt-config-model | 写入数据统计模型信息，并立即生效 |
# 活动实例相关操作接口 OprActivityInst
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/activity-inst/activate-activity-inst | 用于激活一个待激活、未启动状态的活动 |
| /bps/opr/activity-inst/change-activity-inst-state | 改变活动实例的当前状态到指定的目标状态 |
| /bps/opr/activity-inst/create-and-start-activity-inst | 根据流程实例ID和活动定义ID创建并启动一个未运行到的活动 |
| /bps/opr/activity-inst/create-and-start-activity-inst-with-id | 根据流程实例ID、活动定义ID和活动实例ID创建并启动一个未运行到的活动 |
| /bps/opr/activity-inst/execute-rollback-action | 执行活动实例ID对应的回退动作 |
| /bps/opr/activity-inst/find-activity-inst-by-activity-inst-id | 根据活动实例ID查询活动实例 |
| /bps/opr/activity-inst/find-last-activity-inst-by-activity-id | 根据活动定义ID以及流程实例ID，查询最近被实例化的活动实例 |
| /bps/opr/activity-inst/finish-activity-inst | 完成活动实例 |
| /bps/opr/activity-inst/finish-activity-inst-alone | 完成活动实例但不终止正在运行的工作项 |
| /bps/opr/activity-inst/finish-activity-inst-by-activity-id | 完成某个流程实例下的某个活动定义对应的活动实例 |
| /bps/opr/activity-inst/finish-activity-inst-with-relative-data | 完成活动实例,并设置相关数据 |
| /bps/opr/activity-inst/finish-activity-inst-with-t-x-span | 完成活动实例 ,并且设置相关数据和事务分割开关 |
| /bps/opr/activity-inst/generate-activity-inst-id | 生成活动实例ID |
| /bps/opr/activity-inst/get-activity-inst-elapsed-time | 返回该活动实例的总体有效执行时间，即按该工作流配置的工作日历计算得出的工作时间内的活动执行时间 |
| /bps/opr/activity-inst/get-activity-inst-next-state-list | 查询活动实例的后继状态列表 |
| /bps/opr/activity-inst/get-activity-inst-state | 查询个活动实例的状态 |
| /bps/opr/activity-inst/get-unassigned-activity-participart-sequence | 获取未分配活动的参与者 |
| /bps/opr/activity-inst/query-activity-insts-by-activity-id | 查询一个流程下的某个活动定义对应的所有活动实例 |
| /bps/opr/activity-inst/query-activity-insts-by-process-inst-id | 查询某个流程下的所有活动实例 |
| /bps/opr/activity-inst/query-next-act-insts | 根据活动实例ID，查询后继活动实例 |
| /bps/opr/activity-inst/query-previous-activity-insts | 查询某个活动实例的所有前驱实例 |
| /bps/opr/activity-inst/remove-activity-inst | 根据活动实例ID删除活动实例 |
| /bps/opr/activity-inst/restart-activity-inst | 重新启动某个活动实例 |
| /bps/opr/activity-inst/restart-activity-inst-and-set-relative-data | 重新启动某个活动实例.并且设置相关数据和分割事务开关 |
| /bps/opr/activity-inst/resume-activity-inst | 恢复某个活动实例的状态为运行状态 |
| /bps/opr/activity-inst/set-activity-inst-attribute-batch | 批量修改活动实例的基本属性 |
| /bps/opr/activity-inst/set-unassigned-activity-participart-sequence | 设置未分配活动的参与者 |
| /bps/opr/activity-inst/suspend-activity-inst | 挂起某个活动实例 |
| /bps/opr/activity-inst/terminate-activity-inst | 终止活动实例 |
# 代理管理接口 OprAgent
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/agent/add-candidate | 增加委托人的候选人范围 |
| /bps/opr/agent/clear-agent-item | 清理某个代理关系的代理项信息 |
| /bps/opr/agent/create-agents | 创建代理关系 |
| /bps/opr/agent/delete-agent-batch | 批量删除多个代理关系 |
| /bps/opr/agent/delete-candidate | 删除委托人的代理候选人范围 |
| /bps/opr/agent/modify-agent | 修改指定的代理关系 |
| /bps/opr/agent/modify-agent-item | 修改指定代理关系的代理项 |
| /bps/opr/agent/query-agent-candidates | 根据代理关系ID查询代理关系的详细信息 |
| /bps/opr/agent/query-agent-detail | 根据代理关系ID查询代理关系的详细信息 |
| /bps/opr/agent/query-agent-items-by-agent-id | 根据代理关系ID查询代理的流程，活动（部分代理）或者例外的流程（完全代理） |
| /bps/opr/agent/query-agents-by-agent-from | 根据委托人ID查询所有代理关系 |
| /bps/opr/agent/query-agents-by-agent-to | 根据代理人ID查询所有代理关系 |
| /bps/opr/agent/reset-candidate | 重置候选人范围 |
# 指派活动及参与者接口 OprAppointActivity
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/appoint-activity/appoint-activity-participant | 指派后继活动的参与者 |
| /bps/opr/appoint-activity/appoint-activity-participant-by-process-inst-id | 指派后继活动的参与者 |
| /bps/opr/appoint-activity/clear-appointed-activity-participants | 删除某个后继活动已被指定的参与者 |
| /bps/opr/appoint-activity/clear-appointed-participant-by-process-inst-id | 删除某个后继活动已被指定的参与者 |
| /bps/opr/appoint-activity/is-need-appoint-next-activity-participant | 判断当前工作项操作是否需要为后继活动指派参与者 |
| /bps/opr/appoint-activity/query-appointed-activity-participants | 返回指定工作项ID对应活动的所有需要指派参与者的后继活动列表 |
| /bps/opr/appoint-activity/query-next-activites-need-appoint-participant | 返回指定工作项ID对应活动的所有需要指派参与者的后继活动列表 |
# 工作流活动实例回退管理接口 OprBackActivity
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/back-activity/back-activity-1 | 根据某策略回退到某活动 |
| /bps/opr/back-activity/back-activity-2 | 根据某策略回退到某活动 |
| /bps/opr/back-activity/back-activity-3 | 根据某策略回退到某活动 |
| /bps/opr/back-activity/get-previous-activities | 当前实例到目标活动定义之间所有运行时经过的活动定义 |
# 业务表单管理接口 OprBizForm
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/biz-form/query-biz-form-by-act-inst-id | 根据活动实例ID获取业务表单配置信息 |
| /bps/opr/biz-form/query-biz-form-by-act-inst-id-and-type | 根据活动实例ID，表单类型获取业务表单配置信息 |
| /bps/opr/biz-form/query-biz-form-by-proc-inst-id | 根据流程实例ID，活动定义ID获取业务表单配置信息 |
| /bps/opr/biz-form/query-biz-form-by-proc-inst-id-and-type | 根据流程实例ID，活动定义ID，表单类型获取业务表单配置信息 |
| /bps/opr/biz-form/query-biz-form-by-work-item-id | 根据工作项ID获取业务表单配置信息 |
| /bps/opr/biz-form/query-biz-form-by-work-item-id-and-type | 根据工作项ID，表单类型获取业务表单配置信息 |
# 业务流程操作相关接口 OprBizProcess
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/biz-process/can-insert | 是否可以新增业务流程 |
| /bps/opr/biz-process/copy-biz-process | 复制流程 |
| /bps/opr/biz-process/delete-biz-process-def | 删除流程定义 |
| /bps/opr/biz-process/expand-biz-process | 根据流程定义查询流程定义详情 |
| /bps/opr/biz-process/get-biz-process-by-catalog | 查询指定业务目录下的流程定义 |
| /bps/opr/biz-process/get-biz-process-string-by-id | 根据流程定义ID获取流程大字段 |
| /bps/opr/biz-process/get-biz-processs-ch-name-by-name | 根据流程名称查询流程中文名称 |
| /bps/opr/biz-process/get-sub-biz-processes-by-pid | 根据流程定义获取可用的子流程 |
| /bps/opr/biz-process/query-activities-of-biz-process | 根据流程ID查询活动 |
| /bps/opr/biz-process/query-activity-sub-biz-process-def-name | 根据流程ID和活动ID查询子流程名称 |
| /bps/opr/biz-process/query-biz-process-by-name | 通过业务流程名称查询对应该名称的业务流程 |
| /bps/opr/biz-process/query-biz-process-defs | 查询符合条件的业务流程 |
| /bps/opr/biz-process/save-biz-process-def | 保存流程定义 |
| /bps/opr/biz-process/submit-biz-process | 提交流程 |
| /bps/opr/biz-process/validate-biz-process | 验证流程 |
# 业务目录管理接口 OprBusinessCatalog
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/business-catalog/delete-catalog-info | 删除指定业务目录 |
| /bps/opr/business-catalog/find-catalog-info | 根据ID查询业务目录 |
| /bps/opr/business-catalog/query-catalog-infos | 查询符合条件的业务目录 |
| /bps/opr/business-catalog/query-sub-catalogs | 通过业务目录ID(CatalogID)查询下级业务目录 |
| /bps/opr/business-catalog/save-catalog-info | 保存业务目录 |
# 日历管理接口 OprCalendar
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/calendar/get-elapsed-time | 根据日历ID,计算使用该日历情况下，某时间段内的工作时间数 |
| /bps/opr/calendar/get-final-time | 获取超时时间 |
| /bps/opr/calendar/get-next-day | 计算距离某个日期后N个工作日的日期，计算不包括当天。 该方法只关注Date类型里的日期值，不关注Date里的时间值。 返回的日期的时间值统一为00:00:00 |
| /bps/opr/calendar/get-previous-day | 计算距离某个日期前N个工作日的日期，计算不包括当天。 该方法只关注Date类型里的日期值，不关注Date里的时间值。 返回的日期的时间值统一为00:00:00 |
| /bps/opr/calendar/get-previous-time | 获取开始时间之前的时间点 |
# 通用远程接口 OprCommonRemote
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/common-remote/call | 调用接口 |
# 通用管理接口 OprCommon
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/common/batch-execute-apis | 批量执行BPS流程引擎API调用。在一个事务中执行，要么全部成功执行，要么全部失败 |
| /bps/opr/common/delete-biz-info | 删除业务冗余数据 |
| /bps/opr/common/handover | 将移交人的工作任务交接给接管人 |
| /bps/opr/common/handover-process | 将移交人的流程定义交接给接管人（多组） |
| /bps/opr/common/handover-process-1 | 将移交人的流程定义交接给接管人 |
| /bps/opr/common/handover-work-item | 将移交人指定的工作交接给接管人 |
| /bps/opr/common/handover-work-item-batch | 将移交人指定的工作交接给接管人（多组） |
| /bps/opr/common/query-handoverable-processes | 获得移交人需要移交的流程定义 |
| /bps/opr/common/start-tran-history | 执行历史数据迁移 |
| /bps/opr/common/update-biz-info | 更新业务冗余数据 |
# 流程定义部署操作接口 OprDefinitionDeployee
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/definition-deployee/delete-process-by-id | 根据流程定义ID删除流程定义 |
| /bps/opr/definition-deployee/delete-processes-by-name | 删除各版本具有相同名称的流程定义 |
| /bps/opr/definition-deployee/deploy-process | 部署流程定义 |
| /bps/opr/definition-deployee/deploy-process-1 | 部署流程定义 |
| /bps/opr/definition-deployee/refresh-biz-resource-cache | 批量更新业务资源定义缓存 |
| /bps/opr/definition-deployee/refresh-process-def-cache | 批量更新业务流程定义缓存 |
| /bps/opr/definition-deployee/update-process | 更新流程定义 |
| /bps/opr/definition-deployee/update-process-catalog-uuid | 更新流程定义对应的业务目录ID |
# 流程定义发布和取消发布管理接口 OprDefinitionPublish
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/definition-publish/publish-process | 发布某流程定义模板的指定版本 |
| /bps/opr/definition-publish/unpublish-process | 取消某流程定义的发布 |
# 业务流程查询接口 OprDefinitionQuery
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/definition-query/get-activity | 获取某业务流程中某个活动定义的基本信息 |
| /bps/opr/definition-query/get-activity-form | 获取活动的表单设置 |
| /bps/opr/definition-query/get-activity-participants | 获得某业务流程中某活动定义设置在“组织机构与角色”里的参与者 |
| /bps/opr/definition-query/get-extend-attribute | 获取业务流程或者活动定义的扩展属性XML字符串 |
| /bps/opr/definition-query/get-packages | 获得所有的工作流业务构件包列表 |
| /bps/opr/definition-query/get-process | 通过业务流程名称和版本号获取整个业务流程 |
| /bps/opr/definition-query/get-process-1 | 通过业务流程ID获取整个业务流程 |
| /bps/opr/definition-query/get-process-ref-biz-var-xpath-by-name | 根据变量名称获取流程定义的业务变量的XPATH |
| /bps/opr/definition-query/get-process-ref-biz-vars | 获取流程定义的业务变量的定义 |
| /bps/opr/definition-query/get-start-activity | 获取某业务流程中开始活动定义的基本信息 |
| /bps/opr/definition-query/has-published-process | 判断某业务流程是否存在发布的版本 |
| /bps/opr/definition-query/query-activities-of-process | 查询某业务流程中的所有活动定义 |
| /bps/opr/definition-query/query-activity-all-biz-resource | 获取业务流程活动定义绑定的全部业务资源列表 |
| /bps/opr/definition-query/query-activity-biz-resource | 获取业务流程活动定义绑定的业务资源 |
| /bps/opr/definition-query/query-activity-sub-process-def-name | 获取业务流程活动定义绑定的子业务流程名称 |
| /bps/opr/definition-query/query-activity-time-limit-calendar-id | 获取流程活动时间限制工作日历ID |
| /bps/opr/definition-query/query-next-activities | 查询某业务流程中某个活动定义的所有直接后继活动 |
| /bps/opr/definition-query/query-next-transitions | 根据业务流程ID，和活动定义ID查询活动的后继活动连线信息 |
| /bps/opr/definition-query/query-next-transitions-1 | 根据业务流程名称，和活动定义ID查询活动的后继活动连线信息 |
| /bps/opr/definition-query/query-previous-activities | 查询某业务流程中某个活动定义的所有直接前驱活动 |
| /bps/opr/definition-query/query-process-biz-catalog | 获取业务流程的业务目录信息 |
| /bps/opr/definition-query/query-process-by-id | 根据业务流程ID查询业务流程的详细信息 |
| /bps/opr/definition-query/query-process-catalogs-by-pkg-id | 获得一个构建包下的所有业务流程目录 |
| /bps/opr/definition-query/query-process-time-limit-calendar-id | 获取流程时间限制工作日历ID |
| /bps/opr/definition-query/query-processes-by-biz-catalog-uuid | 查询某业务目录下的所有新版本业务流程,支持分页 |
| /bps/opr/definition-query/query-processes-by-biz-catalog-uuid-with-permission | 查询某业务目录下的所有新版本业务流程,支持分页 |
| /bps/opr/definition-query/query-processes-by-name | 通过业务流程名称和状态查询对应该名称的所有业务流程,支持分页查询 |
| /bps/opr/definition-query/query-processes-by-name-1 | 通过业务流程名称查询对应该名称的所有业务流程 |
| /bps/opr/definition-query/query-processes-by-pkg-id | 查询某构件包下的所有业务流程,支持分页 |
| /bps/opr/definition-query/query-processes-by-pkg-id-1 | 查询某构件包下的所有业务流程,支持分页 |
| /bps/opr/definition-query/query-published-processes | 查询所有已发布的业务流程，支持分页 |
| /bps/opr/definition-query/query-published-processes-with-catalog | 查询某业务目录下所有已发布的业务流程，支持分页 |
# 工作项代办管理接口 OprDelegate
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/delegate/confirm-delegated-work-item | 委托人确认代办人提交的代办工作项 |
| /bps/opr/delegate/delegate-work-item | 委托人将工作项代办给代办人 |
| /bps/opr/delegate/delegate-work-item-4-person | 将委托人的工作项代办给代办人（替委托人代办） |
| /bps/opr/delegate/delegate-work-item-directly | 委托人将工作项代办给代办人，不校验权限 |
| /bps/opr/delegate/query-delegation-work-items | 根据委托人ID、代办人、代办方式组合分页查询代办/协办的工作项 |
| /bps/opr/delegate/query-delegation-work-items-1 | 根据委托人ID、代办人ID、代办方式组合分页查询代办/协办的工作项 |
| /bps/opr/delegate/redo-delegated-work-item | 委托人打回代办人代办的工作项 |
| /bps/opr/delegate/reject-delegated-work-item | 代办人拒绝代办工作项 |
| /bps/opr/delegate/withdraw-delegated-work-item | 委托人将代办出去的工作项收回 |
# 自由流相关操作接口 OprFreeFlow
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/free-flow/appoint-next-activities | 设置某自由活动的后继活动 |
| /bps/opr/free-flow/appoint-next-activities-by-activity-inst-id | 设置某活动的后继活动 |
| /bps/opr/free-flow/is-free-activity | 判断工作项ID所对应的活动是否是个自由活动 |
| /bps/opr/free-flow/query-appointed-next-activities | 查询某自由活动已被设置的后继活动 |
| /bps/opr/free-flow/query-next-free-activity-scope | 根据定义的设置，获取某自由活动可能的后继活动 |
| /bps/opr/free-flow/remove-appointed-next-activities | 从已指定的后继活动中删除后继活动 |
# 租户认证接口 OprIdentityAuthentication
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/identity-authentication/get-tenant-identity-token | 查询租户令牌 |
| /bps/opr/identity-authentication/verify-tenant | 校验租户令牌是否合法 |
# 业务资源临时库的管理接口 OprInterimBizResource
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/interim-biz-resource/delete-biz-calendar | 删除工作日历. 1: 成功; 0: 失败 |
| /bps/opr/interim-biz-resource/delete-biz-humantask | 删除人工任务 |
| /bps/opr/interim-biz-resource/delete-biz-operation | 删除业务操作 |
| /bps/opr/interim-biz-resource/delete-biz-rule | 删除业务规则 |
| /bps/opr/interim-biz-resource/delete-biz-var | 删除业务变量 |
| /bps/opr/interim-biz-resource/find-biz-calendar | 简单查询工作日历 |
| /bps/opr/interim-biz-resource/find-biz-humantask | 简单查询人工任务 |
| /bps/opr/interim-biz-resource/find-biz-operation | 简单查询业务操作 |
| /bps/opr/interim-biz-resource/find-biz-rule | 简单查询业务规则 |
| /bps/opr/interim-biz-resource/find-biz-var | 简单查询业务变量 |
| /bps/opr/interim-biz-resource/is-exist-references | 判断业务资源的是否被其他引用 |
| /bps/opr/interim-biz-resource/publish-biz-resource | 将指定的业务资源从临时库发布到运行库 |
| /bps/opr/interim-biz-resource/query-biz-calendar | 分页查询工作日历，支持复杂条件 |
| /bps/opr/interim-biz-resource/query-biz-humantask | 分页查询人工任务，支持复杂条件 |
| /bps/opr/interim-biz-resource/query-biz-operation | 分页查询业务操作，支持复杂条件 |
| /bps/opr/interim-biz-resource/query-biz-rule | 分页查询业务规则，支持复杂条件 |
| /bps/opr/interim-biz-resource/query-biz-var | 分页查询业务变量，支持复杂条件 |
| /bps/opr/interim-biz-resource/save-biz-calendar | 保存工作日历 |
| /bps/opr/interim-biz-resource/save-biz-humantask | 保存人工任务 |
| /bps/opr/interim-biz-resource/save-biz-operation | 保存业务操作 |
| /bps/opr/interim-biz-resource/save-biz-rule | 保存业务规则 |
| /bps/opr/interim-biz-resource/save-biz-var | 保存业务变量 |
# 业务流程定制的流程定义管理接口 OprInterimDefinition
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/interim-definition/delete-w-f-biz-process-def | 删除业务流程定义 |
| /bps/opr/interim-definition/query-activities-of-process | 查询流程定义中的活动列表 |
| /bps/opr/interim-definition/query-biz-process | 查询流程定义临时库中业务流程 |
| /bps/opr/interim-definition/query-biz-process-1 | 分页查询业务流程,支持复杂条件 |
| /bps/opr/interim-definition/query-process-by-name | 查询流程定义临时库中的业务流程 |
| /bps/opr/interim-definition/query-process-content-by-id | 获取流程定义的内容，返回为XML格式 |
| /bps/opr/interim-definition/save-w-f-biz-process-def | 保存流程定义 |
# 通知(抄送)相关操作的接口 OprNotification
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/notification/confirm-notification | 确认(阅读)通知 |
| /bps/opr/notification/delete-notification | 删除通知 |
| /bps/opr/notification/query-notifications | 查询通知 |
| /bps/opr/notification/query-un-viewed-activity-inst-notifications | 查询未确认的活动实例通知 |
| /bps/opr/notification/query-un-viewed-process-inst-notifications | 查询未确认的流程实例通知 |
| /bps/opr/notification/query-un-viewed-task-notifications | 查询未确认的任务通知 |
| /bps/opr/notification/query-viewed-activity-inst-notifications | 查询已阅读的活动实例通知 |
| /bps/opr/notification/query-viewed-process-inst-notifications | 查询已阅读的流程实例通知 |
| /bps/opr/notification/query-viewed-task-notifications | 查询已阅读的任务通知 |
| /bps/opr/notification/send-activity-inst-notification | 给指定的参与者发送活动实例通知 |
| /bps/opr/notification/send-process-inst-notification | 给指定的参与者发送流程实例通知 |
| /bps/opr/notification/send-task-notification | 给指定的参与者发送任务通知 |
| /bps/opr/notification/send-task-notification-to-person | 给指定的人发送任务通知 |
# 组织模型接口 OprOm
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/om/find-participant-by-id | 通过ID查找指定的参与者 |
| /bps/opr/om/find-root-participants | 获取某类型下的根参与者 |
| /bps/opr/om/get-all-child-participants | 查询所有下级参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理） |
| /bps/opr/om/get-all-parent-participants | 查询所有上级参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理） |
| /bps/opr/om/get-child-participants | 查询某类型的下属参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理） |
| /bps/opr/om/get-joint-child-participant | 查询交集类型参与者的所有下属参与者,查询到的参与者不一定全是叶子参与者 |
| /bps/opr/om/get-parent-participants | 查询某类型的上级参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理） |
| /bps/opr/om/get-participant-scope | 获取某个参与者的参与范围 |
| /bps/opr/om/get-participant-type | 根据code获取参与者类型 |
| /bps/opr/om/get-participant-types | 获取所有的参与者类型 |
| /bps/opr/om/get-participants | 获取某个类型的所有参与者，需要按照PageCond的begin,length要求做分页。 |
# 流程引擎操作日志接口 OprOptMsg
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/opt-msg/add-activity-inst-opt-msg | 增加活动实例操作日志 |
| /bps/opr/opt-msg/add-proc-inst-opt-msg | 增加流程实例操作日志 |
| /bps/opr/opt-msg/add-work-item-opt-msg | 增加工作项操作日志 |
| /bps/opr/opt-msg/query-activity-inst-opt-msgs | 根据流程实例ID查询所有的活动实例操作 |
| /bps/opr/opt-msg/query-opt-msg-detail | 根据操作日志ID查询操作日志信息 |
| /bps/opr/opt-msg/query-opt-msgs | 通过查询模板查询操作日志 |
| /bps/opr/opt-msg/query-opt-msgs-by-activity-id | 根据活动实例ID和操作类型查询所有的操作日志 |
| /bps/opr/opt-msg/query-opt-msgs-by-process-id | 根据流程实例ID和操作类型查询所有的操作日志 |
| /bps/opr/opt-msg/query-opt-msgs-by-work-item-id | 根据工作项ID和操作类型查询所有的工作项操作 |
| /bps/opr/opt-msg/query-proc-inst-opt-msgs | 根据流程实例ID查询所有的流程实例操作 |
| /bps/opr/opt-msg/query-work-item-opt-msgs | 根据流程实例ID查询所有的工作项操作 |
# 查询参与者接口 OprParticipantQuery
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/participant-query/query-participants | 根据参与者信息查询参与者 |
# 权限服务管理相关操作接口 OprPermission
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/permission/get-permissions | 获取用户具有的权限列表 |
| /bps/opr/permission/has-permission | 获取用户具有的权限列表 |
| /bps/opr/permission/validate | 验证用户密码 |
# 流程实例管理、查询接口 OprProcessInst
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/process-inst/add-and-start-process-with-parent-activity-inst-id | 创建并启动工作流实例，同时将它作为子流程实例关联到指定的父流程实例上，返回流程实例ID |
| /bps/opr/process-inst/change-process | 根据流程实例ID，更换该流程实例的流程定以模板 |
| /bps/opr/process-inst/change-process-inst-state | 改变一个流程实例的状态 |
| /bps/opr/process-inst/clear-process-inst-time-limit | 关闭流程实例上的超时时间和超时提醒 |
| /bps/opr/process-inst/create-and-start-proc-inst-and-set-relative-data | 创建启动流程实例并且设置相关数据 |
| /bps/opr/process-inst/create-and-start-proc-inst-by-version-and-set-relative-data | 创建启动流程实例并且设置相关数据 |
| /bps/opr/process-inst/create-and-start-process-instance | 创建并启动工作流实例 |
| /bps/opr/process-inst/create-and-start-process-instance-1 | 创建并启动工作流实例 |
| /bps/opr/process-inst/create-and-start-process-instance-2 | 创建并启动工作流实例 |
| /bps/opr/process-inst/create-and-start-process-instance-by-version | 创建并启动工作流实例 |
| /bps/opr/process-inst/create-and-start-process-instance-by-version-1 | 创建并启动工作流实例 |
| /bps/opr/process-inst/create-and-start-process-instance-with-id | 根据流程实例ID创建并启动工作流实例 |
| /bps/opr/process-inst/create-and-start-process-with-parent-activity-inst-id | 创建并启动工作流实例，同时将它作为子流程实例关联到指定的父流程实例上 |
| /bps/opr/process-inst/create-process-instance | 创建工作流实例 |
| /bps/opr/process-inst/create-process-instance-by-version | 创建工作流实例 |
| /bps/opr/process-inst/create-process-instance-with-id | 创建工作流实例 |
| /bps/opr/process-inst/delete-process-inst-batch | 根据流程实例ID批量删除流程实例，操作成功全部删除，操作失败都不删除 |
| /bps/opr/process-inst/delete-process-instance | 根据流程实例ID去删除流程实例 |
| /bps/opr/process-inst/excute-annotate-process-instance | 执行流程实例批注 |
| /bps/opr/process-inst/excute-press-process-instance | 执行流程实例催办 |
| /bps/opr/process-inst/generate-process-inst-id | 根据流程定义名称和流程定义版本信息生成流程实例ID |
| /bps/opr/process-inst/get-next-active-and-participants | 预计算后继活动以及参与者 |
| /bps/opr/process-inst/get-next-activities-maybe-arrived | 查询满足条件的后继活动，可以查询出非路由活动的各种类型的后继活动 |
| /bps/opr/process-inst/get-probable-participants | 根据当前相关数据解析某个活动定义的参与者 |
| /bps/opr/process-inst/get-process-inst-elapsed-time | 返回该流程实例的总体有效执行时间，即按该工作流配置的工作日历计算得出的工作时间内的流程执行时间 |
| /bps/opr/process-inst/get-process-inst-next-states | 查询某个流程实例的可转换状态列表 |
| /bps/opr/process-inst/get-process-inst-state | 查询工作流实例的状态 |
| /bps/opr/process-inst/query-annotate-list-by-process-inst-id | 查询流程实例批注列表 |
| /bps/opr/process-inst/query-approval-msg-by-process-inst-id | 根据当前工作项所对应的流程实例ID查询审批意见列表 |
| /bps/opr/process-inst/query-press-list-by-process-inst-id | 查询流程实例催办列表 |
| /bps/opr/process-inst/query-process-inst-detail | 查询流程实例的详细信息 |
| /bps/opr/process-inst/query-process-insts-by-biz-catalog-uuid | 通过业务目录ID查询业务流程实例 |
| /bps/opr/process-inst/query-process-insts-by-process-id | 根据流程定义ID，获取流程实例列表 |
| /bps/opr/process-inst/query-process-insts-with-activity-state | 按照流程定义ID、活动定义ID和状态查询所有的流程实例 |
| /bps/opr/process-inst/query-process-transitoin-records | 根据当前流程实例ID查询 流程流转记录 |
| /bps/opr/process-inst/query-sub-process-inst-ids-by-activity-inst-id | 根据子流程活动实例ID查询活动对应的子流程实例ID列表 |
| /bps/opr/process-inst/refresh-process-inst-cache | 批量更新流程实例缓存 |
| /bps/opr/process-inst/restart-finished-process-inst | 重启已完成的流程实例（未转历史） |
| /bps/opr/process-inst/restart-finished-process-inst-1 | 重启已完成的流程实例（未转历史），激活指定活动并指派参与者 |
| /bps/opr/process-inst/resume-process-instance | 恢复某个被挂起的流程实例 |
| /bps/opr/process-inst/set-process-inst-attribute-batch | 批量修改流程实例的基本属性 |
| /bps/opr/process-inst/set-process-inst-time-limit | 修改指定流程实例的时间限制 |
| /bps/opr/process-inst/start-process-inst-and-finish-first-work-item | 启动工作流实例,并完成第一个工作项 |
| /bps/opr/process-inst/start-process-instance | 启动工作流实例 |
| /bps/opr/process-inst/start-process-instance-1 | 启动工作流实例 |
| /bps/opr/process-inst/start-process-instance-with-biz-info | 启动流程实例并且设置业务冗余数据 |
| /bps/opr/process-inst/suspend-process-instance | 挂起某个流程实例 |
| /bps/opr/process-inst/terminate-process-instance | 终止某个流程实例 |
| /bps/opr/process-inst/terminate-process-instance-and-compensate | 终止某个流程实例, 并调用流程和上活动已经配置的回退补偿 |
| /bps/opr/process-inst/upgrade-process-instance | 升级一个流程实例 |
# 工作流实例相关的日志管理接口 OprProcessLog
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/process-log/add-process-log | 记录代理代办相关操作的日志 |
| /bps/opr/process-log/get-process-log-by-activity-id | 根据活动定义获取该活动定义代理代办相关操作的日志 |
| /bps/opr/process-log/get-process-log-by-activity-inst-id | 根据活动实例ID获取该活动实例代理代办相关操作的日志 |
| /bps/opr/process-log/get-process-log-by-process-inst-id | 根据流程实例获取该实例的所有代理代办相关操作日志 |
| /bps/opr/process-log/get-process-log-by-work-item-id | 根据工作项ID获取该工作项代理代办相关操作的日志 |
# 工作流通用查询接口 OprQuery
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/query/query-activity-instances | 根据条件查询活动实例 |
| /bps/opr/query/query-agents | 根据代理查询条件查询所有的代理信息 |
| /bps/opr/query/query-audit-records | 根据条件查询审计日志 |
| /bps/opr/query/query-process-instances | 根据条件查询流程实例 |
| /bps/opr/query/query-processes | 根据条件查询流程定义对象 |
| /bps/opr/query/query-work-items | 根据条件查询工作项 |
# 工作流相关数据管理接口 OprRelativeData
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/relative-data/append-relative-data-item | 向数组或者集合类型的相关数据添加值对象 |
| /bps/opr/relative-data/get-relative-data | 根据流程实例ID，获得相关数据中指定路径下的值 | | /bps/opr/relative-data/get-relative-data-batch | 批量获得相关数据中指定路径下的值 | | /bps/opr/relative-data/remove-relative-data-batch | 根据流程实例ID，移除相关数据中指定路径下的节点 | | /bps/opr/relative-data/set-relative-data | 根据流程实例ID，将对象值放到相关数据区中指定的xpath下 | | /bps/opr/relative-data/set-relative-data-batch | 根据流程实例ID，批量设置相关数据中指定路径下的值 | | /bps/opr/relative-data/set-relative-data-batch-1 | 根据流程实例ID，批量设置相关数据中指定路径下的值 |
# 业务资源运行库管理接口 OprRuntimeBizResource
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/runtime-biz-resource/find-biz-humantask | 查询人工任务 |
| /bps/opr/runtime-biz-resource/find-biz-operation | 查询业务操作 |
| /bps/opr/runtime-biz-resource/find-biz-rule | 查询业务规则 |
| /bps/opr/runtime-biz-resource/find-biz-var | 查询业务变量 |
# 工作流安全权限管理接口 OprSecurity
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/security/has-access-process-permission | 验证已登陆人员是否具有启动流程的权限 |
| /bps/opr/security/has-access-work-item-permission | 验证已登陆人员是否具有执行工作项的权限 |
| /bps/opr/security/query-person-startable-processes | 查询某人可以启动的流程定义列表 |
| /bps/opr/security/query-self-startable-processes | 查询已登录人可以启动的流程 |
# 工作流异常监控接口 OprSupervision
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/supervision/query-auto-activity-insts-with-exception | 根据条件查询异常状态的自动活动 |
# 任务池接口 OprTaskPool
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/task-pool/add-task-resource | 添加任务到任务池 |
| /bps/opr/task-pool/add-task-resource-from-work-item | 添加流程工作项到任务池中指定队列 |
| /bps/opr/task-pool/append-exclude-participant | 在原来基础上追加排除的参与者 |
| /bps/opr/task-pool/get-one-task | 根据队列名获取一个任务 |
| /bps/opr/task-pool/remove-exclude-participant | 根据排除参与者编号，清空排除参与者 |
| /bps/opr/task-pool/remove-task-resource | 指定任务ID，从任务池中删除任务 |
| /bps/opr/task-pool/set-exclude-participant | 重设excludeUniqueID对应的排除参与者字符串，此字符串中多个参与者之间用半角英文","分割 |
# 工作项拽回管理接口 OprWorkItemDrawback
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/work-item-drawback/drawback-work-item | 拽回工作项 |
| /bps/opr/work-item-drawback/is-drawback-enable | 判断任务是否可以拽回 |
# 工作项管理接口 OprWorkItem
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/work-item/add-approval-msg | 添加审批意见 |
| /bps/opr/work-item/add-work-item | 动态增加某个活动实例的工作项 |
| /bps/opr/work-item/add-work-item-participant | 新增工作项的参与者 |
| /bps/opr/work-item/assign-work-item-to-person | 指派工作项给指定人员（替别人领取） |
| /bps/opr/work-item/assign-work-item-to-self | 已登录人员领取工作项（按工作项ID领取） |
| /bps/opr/work-item/clear-work-item-participant | 清除工作项的所有参与者 |
| /bps/opr/work-item/clear-work-item-time-limit | 清除工作项时间限制 |
| /bps/opr/work-item/create-workitem | 动态增加某个活动实例的工作项 |
| /bps/opr/work-item/create-workitem-with-id | 动态增加某个活动实例的工作项 |
| /bps/opr/work-item/excute-annotate-task | 执行任务批注 |
| /bps/opr/work-item/excute-press-task | 执行任务催办 |
| /bps/opr/work-item/finish-work-item | 完成指定工作项 |
| /bps/opr/work-item/finish-work-item-1 | 完成指定工作项 |
| /bps/opr/work-item/finish-work-item-4-person | 代替某人提交工作项 |
| /bps/opr/work-item/finish-work-item-batch | 批量提交工作项 |
| /bps/opr/work-item/finish-work-item-directly | 完成指定工作项 |
| /bps/opr/work-item/finish-work-item-with-option | 完成指定工作项 |
| /bps/opr/work-item/finish-work-item-with-relative-data | 完成指定工作项 |
| /bps/opr/work-item/generate-work-item-id | 生成工作项ID |
| /bps/opr/work-item/get-approval-msg-by-task-id | 根据任务ID获取审批意见 |
| /bps/opr/work-item/get-next-action-list | 获取某一工作项下一个可执行动作列表 |
| /bps/opr/work-item/get-work-item-elapsed-time | 返回该工作项的总体有效执行时间，即按该工作流配置的工作日历计算得出的工作时间内的工作项执行时间 |
| /bps/opr/work-item/modify-process-inst-name | 修改工作项的流程实例名称 |
| /bps/opr/work-item/modify-work-item-name | 修改工作项名称 |
| /bps/opr/work-item/modify-work-item-url | 修改工作项url |
| /bps/opr/work-item/query-annotate-list-by-task-id | 根据任务ID查询批注列表 |
| /bps/opr/work-item/query-next-work-items-by-activity-inst-id | 查询出当前活动完成后生成下一个活动的工作项 |
| /bps/opr/work-item/query-next-work-items-by-process-inst-id | 查询指定流程实例启动后生成下一个活动的工作项 |
| /bps/opr/work-item/query-next-work-items-by-work-item-id | 查询出已完成的工作项生成的后继活动的工作项 |
| /bps/opr/work-item/query-opt-msg-by-task-id | 查询当前任务所在的流程的操作列表 |
| /bps/opr/work-item/query-press-list-by-task-id | 根据任务ID查询催办列表 |
| /bps/opr/work-item/query-rest-work-items-count-by-work-item-id | 根据当前工作项所在的活动实例，查询活动实例下未完成的工作项 |
| /bps/opr/work-item/query-work-item-delay | 根据工作项ID查询工作项超时数 |
| /bps/opr/work-item/query-work-item-detail | 根据传入的工作项ID查询工作项的详细信息 |
| /bps/opr/work-item/query-work-item-participant-info | 查询工作项参与者 |
| /bps/opr/work-item/query-work-item-url | 查询某个工作项的调用URL |
| /bps/opr/work-item/query-work-items-by-activity-inst-id | 查询指定活动的工作项 |
| /bps/opr/work-item/query-work-items-by-process-inst-id | 根据当前流程实例ID查询 工作项记录 |
| /bps/opr/work-item/reassign-work-item | 将指定的工作项改派到指定的参与者（只能是个人） |
| /bps/opr/work-item/reassign-work-item-and-update-start-time | 将指定的工作项改派到指定的参与者（只能是个人）, 并更新工作项开始时间 |
| /bps/opr/work-item/reassign-work-item-and-update-start-time-ex | 将工作项改派给指定的参与者，可以改派给多个个人、机构、角色, 并更新工作项开始时间 |
| /bps/opr/work-item/reassign-work-item-ex | 将工作项改派给指定的参与者，可以改派给多个个人、机构、角色 |
| /bps/opr/work-item/remove-work-item | 删除工作项 |
| /bps/opr/work-item/remove-work-item-participant | 删除工作项的某个参与者 |
| /bps/opr/work-item/restart-work-item | 重启动已经结束的工作项 |
| /bps/opr/work-item/resume-work-item | 恢复指定的工作项 |
| /bps/opr/work-item/save-work-item-with-option | 保存指定工作项 |
| /bps/opr/work-item/set-work-item-time-limit | 设置工作项时间限制 |
| /bps/opr/work-item/suspend-workitem | 挂起指定的工作项 |
| /bps/opr/work-item/terminate-work-item | 终止指定的工作项 |
| /bps/opr/work-item/update-approval-msg | 根据审批意见ID修改审批意见 |
| /bps/opr/work-item/withdraw-work-item | 取消领取某个工作项 |
# 工作项查询接口 OprWorklistQuery
| 接口URL | 接口名称 |
|---|---|
| /bps/opr/worklist-query/query-collective-work-items | 查询指定集合（角色、机构、岗位）的工作项 |
| /bps/opr/worklist-query/query-person-entrust-finished-work-items | 查询指定人员委托出去并且已经完成的工作项信息 |
| /bps/opr/worklist-query/query-person-entrust-finished-work-items-with-biz-info | 查询指定人员委托出去并且已经完成的工作项信息 |
| /bps/opr/worklist-query/query-person-entrust-work-items | 查询指定人员委托出去的工作项信息 |
| /bps/opr/worklist-query/query-person-entrust-work-items-with-biz-info | 查询指定人员委托出去的工作项信息 |
| /bps/opr/worklist-query/query-person-finished-work-items | 查询指定人员完成的工作项 |
| /bps/opr/worklist-query/query-person-finished-work-items-with-biz-info | 查询指定人员完成的工作项（结合业务冗余数据查询条件) |
| /bps/opr/worklist-query/query-person-finished-work-items-with-biz-info-1 | 查询指定人员完成的工作项（结合业务冗余数据查询条件) |
| /bps/opr/worklist-query/query-person-work-items | 查询指定人员的工作项列表 |
| /bps/opr/worklist-query/query-person-work-items-with-biz-info | 查询指定人员的待领取或者正在运行的工作项列表（结合业务冗余数据查询条件) |
| /bps/opr/worklist-query/query-person-work-items-with-biz-info-1 | 查询指定人员的待领取或者正在运行的工作项列表（结合业务冗余数据查询条件) |
| /bps/opr/worklist-query/query-work-item-biz-info | 扩展工作项的业务属性。该方法必须在EOS PlatForm平台上使用，BPS 6.0中该方法无法使用！ |