该文档详细阐述了工作流流程触发器接口的使用方法和注意事项,包括接口定义、请求参数、响应格式等关键信息。目的是帮助开发者正确实现工作流的自动化触发,确保流程顺畅执行。
工作流流程触发器接口说明文档_工作流程

(图片来源网络,侵删)
1.
本文档旨在详细说明工作流流程触发器接口的使用方法,包括接口的定义、参数、请求和响应格式以及可能的错误代码,工作流流程触发器是用于启动或触发特定工作流实例的机制,它允许系统在满足一定条件时自动执行预定义的流程。
2. 接口定义
2.1 接口URL
POST /api/workflow/triggers
2.2 请求头
| 字段 | 类型 | 描述 |
| Authorization | String | 必需,Bearer Token形式的身份验证信息 |
| ContentType | String | 必需,设置为application/json |
2.3 请求体

(图片来源网络,侵删)
请求体必须包含JSON格式的数据,如下所示:
{
"workflow_id": "string",
"input_data": {
"key1": "value1",
"key2": "value2"
}
}
workflow_id: 字符串,指定要触发的工作流的唯一标识符。
input_data: 对象,包含作为工作流启动输入的数据。
2.4 响应体
成功触发工作流后,接口将返回以下JSON格式的响应体:
{
"status": "success",
"workflow_instance_id": "string"
}
status: 字符串,表示请求的状态,成功时为success。
workflow_instance_id: 字符串,新触发的工作流实例的唯一标识符。

(图片来源网络,侵删)
2.5 错误响应
如果请求失败,接口将返回一个包含错误信息的JSON对象:
{
"status": "error",
"message": "错误描述"
}
status: 字符串,表示请求的状态,失败时为error。
message: 字符串,提供错误的详细描述。
3. 使用示例
3.1 触发工作流
请求示例:
curl X POST \
https://example.com/api/workflow/triggers \
H 'Authorization: Bearer <your_token>' \
H 'ContentType: application/json' \
d '{
"workflow_id": "sample_workflow",
"input_data": {
"name": "John Doe",
"email": "john@example.com"
}
}'
响应示例:
{
"status": "success",
"workflow_instance_id": "1234567890"
}
4. 错误代码
以下是一些可能的错误代码及其描述:
| 错误代码 | 描述 |
| 401 | 未授权,缺少有效的认证信息 |
| 403 | 禁止访问,用户没有权限触发工作流 |
| 404 | 未找到,指定的工作流ID不存在 |
| 500 | 内部服务器错误,无法完成请求 |
5. FAQs
Q1: 如果工作流ID不存在会怎么样?
A1: 如果提供的workflow_id 不存在于系统中,接口将返回一个404错误,并附带一条消息指出工作流ID未找到。
Q2: 我如何知道工作流是否成功触发?
A2: 当工作流被成功触发时,接口将返回一个状态为success 的响应,并且提供一个workflow_instance_id,这是新创建工作流实例的唯一标识符,您可以使用此ID来跟踪和管理您的工作流实例。