文档首页> 应用魔方 AppCube> API参考> API> BPM> 挂起/恢复/终止BPM实例
更新时间:2022-04-27 GMT+08:00
分享

挂起/恢复/终止BPM实例

功能介绍

挂起/恢复/终止一个BPM实例。BPM实例被挂起后,不会在用户的待办任务列表中出现,流程SLA定时器停止,也不会进行任何跟催;恢复后可继续进行操作;终止操作则强行结束一个BPM实例,可在历史任务中查看。

URI

PUT AppCube域名/u-route/baas/bp/v2.0/runtime/instances/{instance_id}

参数说明请参见表1

表1 参数说明

参数

是否必选

描述

instance_id

对应一个具体BPM实例的标识。

请求参数

请求参数如表2所示。

表2 请求参数

参数

是否必选

参数类型

描述

action

String

代表对BPM实例操作的动作名。取值如下:

  • suspend:挂起
  • resume:恢复
  • terminate:终止
  • restart:重启
  • cancel:撤销
  • rollBackPreviousTask:打回任务,即管理员或当前任务处理人将流程回退到上一步任务。
  • revokePreviousTask:撤回任务,即任务提交人撤回已提交审批的任务,任务重新回到待审批。

响应参数

响应参数如表3所示。

表3 响应参数

参数

参数类型

描述

resCode

String

返回码,如果返回“0”代表请求成功,其他错误码说明请参考错误码

resMsg

String

返回消息,如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。

result

Object

在成功请求时会有内容,返回启动BPM之后,BPM实例的运行信息。

请求示例

对一个已启动运行的BPM实例进行暂停操作,被操作的BPM实例ID是“002N000000Q3QW4IMAOO”。
PUT https://AppCube域名/u-route/baas/bp/v2.0/runtime/instances/002N000000Q3QW4IMAOO
    
{
    "action": "suspend"
}

响应示例

可以看到返回的报文中,BPM实例的suspended字段被置为了true。

{
    "resCode":"0",
    "resMsg":"Success",
    "result":{
        "name":"SimpleBP",
        "version":"1.0.1",
        "id":"002N000000Q3QW4IMAOO",
        "processDefID":"001L000000Peuw1Q318a",
        "interviewLabel":"SimpleBP 2019-05-10 15:14:09",
        "nextElem":"",
        "isTest":true,
        "state":"New",
        "bpStatus":"New",
        "urgency":0,
        "taskOutcome":"",
        "businessKey":"002N000000Q3QW4IMAOO",
        "startTime":"2019-05-10 15:14:09",
        "endTime":"",
        "Ext1":"",
        "Ext2":"",
        "Ext3":"",
        "Ext4":"",
        "Ext5":"",
        "Ext6":"",
        "Ext7":0,
        "Ext8":0,
        "suspended":true,
        "isClosed":false
    }
}

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

关闭导读