更新时间:2024-07-18 GMT+08:00
分享

启动BPM实例

功能介绍

创建并启动一个BPM实例。

启动BMP实例前,需要先通过界面编排定义好BPM的元数据信息。

URI

POST AstroZero域名/u-route/baas/bp/v2.0/runtime/instances

请求参数

表1 请求参数

参数

是否必选

参数类型

描述

name

String

参数解释

BPM的名称,请参考登录应用设计器中操作,进入应用设计器,在流程 > 工作流列表中查看。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

version

String

参数解释

BPM的版本号,一个BPM可以存在多个版本。如果不带版本号,表示运行当前启用的版本。获取方法如下:

  1. 参考登录应用设计器中操作,进入应用设计器。
  2. 流程 > 工作流中,单击,选择“详情”
  3. 在工作流详情页的“基本信息”中,可查看到工作流的版本号。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

variables

Object

参数解释

BPM元数据中定义的变量,包括自定义变量和系统变量,为key-value形式,其中key为变量名,value为变量的值。如果需要在启动BPM前设置BPM的变量,可以填写该参数。如需启动时设置变量,可以在variables中设置系统变量$Flow.BusinessKey。如需设置BPM title,可以设置系统变量$Flow.Title。

约束限制

不涉及。

响应参数

表2 响应参数

参数

参数类型

描述

resCode

String

参数解释

返回码。

取值范围

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

resMsg

String

参数解释

返回消息。

取值范围

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

result

Object

参数解释

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

请求示例

创建并启动一个BPM实例,例如创建并启动了一个BPM,BPM名称为“createCloudOK_NEW”,版本号为“1.0.1”,带有4个启动参数。
POST https://AstroZero域名/u-route/baas/bp/v2.0/runtime/instances
    
 {
    "name":"createCloudOK_NEW",
    "version":"1.0.1",
    "variables":{
        "name":"sun",
        "memorySize":"15",
        "storageSize":"15",
        "expiryDate":"2018-12-12"
    }
}

响应示例

{
    "resCode":"0",
    "resMsg":"Success",
    "result":{
        "name":"bpName1",
        "version":"1.0.1",
        "id":"002N000000Sy2NphoRbU",
        "processDefID":"001L000000S8Yi3xG9Gi",
        "interviewLabel":"BP Label 1",
        "nextElem":"subProcess",
        "isTest":true,
        "state":"Dispatched",
        "bpStatus":"New",
        "urgency":0,
        "taskOutcome":"",
        "businessKey":"002N000000Sy2NphoRbU",
        "startTime":"2019-08-27 10:53:04",
        "endTime":"",
        "Ext1":"",
        "Ext2":"",
        "Ext3":"",
        "Ext4":"",
        "Ext5":"",
        "Ext6":"",
        "Ext7":0,
        "Ext8":0,
        "suspended":false,
        "isClosed":false
    }
}

状态码

状态码请参见状态码

错误码

错误码请参见错误码

相关文档