添加流程实例清除周期任务配置

POST

/engine/instanceClean

流程实例清除

周期任务json描述
{
"id": "", // 配置ID
"disabled": false, // 是否禁用，true禁用，false不禁用
"name": "按天归档2", // 配置名称
"flowName": {"$in": ["测试周期1", "测试周期2"]}, // 流程名称
"status": "COMPLETE", // 流程实例执行状态 COMPLETED/FAILED，
"cycle": 1, // 周期
"cycle_type": "day", // 日期单位 "day/week/month/year"
"duration": 1, // 保留天数
"time_config": { // 时间配置
"month": "January", // 月份：月份英文
"weekday": "WED", // 星期：星期英文前三位大写
"day": 1, // 天数：int
"hms": "15:38:00" // 时间
},
"clean_archive": false, // 清除时是否同时清除同配置归档信息
"task_type": "cycle", // 任务类型 "cycle/archiveCycle"
}

请求参数

Header 参数

x-request-project

string

可选

项目ID, 默认default

Authorization

string

Token

可选

默认值:

Body 参数application/json

clean_archive

boolean

是否清除归档数据

可选

cycle

integer

周期数

可选

cycle_type

string

周期类型

可选

示例值:

year/month/week/day

disabled

boolean

是否禁用

可选

duration

integer

保留天数

可选

flowName

流程

可选

string

可选

name

string

计划名称

可选

status

string

状态

可选

task_type

string

可选

任务类型：清除/归档

time_config

object

周期配置

可选

day

integer

日

可选

hms

string

时分秒

可选

示例值:

10:30:00

month

string

月

可选

示例值:

January/JAN

weekday

string

周

可选

示例值:

Monday/MON

user

object

创建用户

可选

remoteAddr

string

可选

user

string

可选

示例

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/engine/instanceClean' \
--header 'Authorization: {{ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200OK

application/json

Body

InsertedID

string

可选

示例值:

5cceba2cc7157e23ae172c28

示例

{
  "InsertedID": "5cceba2cc7157e23ae172c28"
}

🟠400请求发生错误

🟠401无效令牌或token过期

🔴500服务器发生错误

修改于 2024-05-14 02:42:02

根据过滤器查询流程实例清除周期任务配置

执行一次性清除流程实例