文档首页> 应用魔方 AppCube> API参考> API> BPM> 获取所有BPM实例
更新时间:2022-04-27 GMT+08:00
分享

获取所有BPM实例

功能介绍

获取当前帐号所有的BPM实例信息。

URI

GET AppCube域名/u-route/baas/bp/v2.0/runtime/instances

请求参数

请求参数如表1所示。

表1 请求参数

参数

是否必选

参数类型

描述

fields

String

指明要查询的字段,多个字段名字之间以逗号分隔,可选参数;如果不指明字段,则返回缺省的字段。

orderField

String

用来排序的字段名字,可选参数。

orderType

String

排序类型,取值如下:

  • asc:升序
  • desc:降序

响应参数

响应参数如表2所示。

表2 响应参数

参数

参数类型

描述

resCode

String

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

resMsg

String

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

result

Object

在成功请求时会有内容,返回查询到的BPM实例信息列表。

请求示例

查询当前BPM实例列表,例如示例中查询到了一个匹配的记录项。
GET https://AppCube域名/u-route/baas/bp/v2.0/runtime/instances?orderField=title&orderType=asc

响应示例

{
    "resCode":"0",
    "resMsg":"Success",
    "result":[
        {
            "bpStage":"Stage 1",
            "bpStatus":"begin",
            "bpStep":"Transfer 1",
            "businessKey":"BK001",
            "createdBy":"10gd0000003T2E10UTfk",
            "createdBy.__objectType":"User",
            "createdBy.name":"ecommerce",
            "createdDate":"2018-08-13 16:21:17",
            "curElement":"",
            "description":"Transfer 1",
            "endTime":"2018-08-17 14:40:09",
            "id":"002N000000IpNGFfNvm4",
            "label":"TestFSM2 2018-08-13 16:21:17",
            "lastHandler":null,
            "lastModifiedBy":"10gd0000003T2E10UTfk",
            "lastModifiedBy.__objectType":"User",
            "lastModifiedBy.name":"ecommerce",
            "lastModifiedDate":"2018-08-17 14:40:09",
            "name":"TestFSM2",
            "owner":"10gd0000003T2E10UTfk",
            "owner.__objectType":"User",
            "owner.name":"ecommerce",
            "startTime":"2018-08-13 16:21:17",
            "state":"User Terminated",
            "suspended":false,
            "title":"Hello, this is a title",
            "type":"BP",
            "urgency":0,
            "version":"0.0.1"
        }
    ]
}

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

close