结束流程实例

接口调用

该接口用于管理员结束当前流程实例。

**请求地址：**https://api.jiandaoyun.com/api/v1/workflow/instance/close

请求频率：20 次/秒

请求方式：POST

请求参数:

参数	必须	类型	说明
instance_id	是	String	实例 id，同 data_id。结束对应的流程实例。

请求示例：

{
    "instance_id": "6358a65878b1fb0007aba61b"
}

响应参数：

参数	类型	说明
status	String	success：表示接口调用成功failure：表示接口调用失败（失败时会有错误码，错误码描述等信息）
code	Number	错误码
message	String	返回码的描述

响应示例：

成功示例

{
    "status": "success"
}

失败示例

{
    "code": 4008,
    "message": "操作失败,流程已经关闭",
    "status": "failure"
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

instance_id

string

必需

实例 id，同 data_id。结束对应的流程实例。

示例

{
    "instance_id": "6358a65878b1fb0007aba61b"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

number

错误码

可选

message

string

返回码的描述

可选

status

string

必需

success：表示接口调用成功 failure：表示接口调用失败（失败时会有错误码，错误码描述等信息）

示例

成功示例异常示例

{
    "status": "success"
}

结束流程实例

接口调用#

请求参数

示例代码

返回响应

接口调用