本协议约定低代码平台流程引擎需要提供的相关API接口的规范，包括请求接口参数，返回值等规则。

​

API 清单

​

API 规范

以下是各个流程 API 的详细规范。

​

发起审批

新建一个草稿状态的审批单。

​

URI

/api/workflow/open/drafts

​

请求参数

请求该接口时需要传入以下参数。

applicant 与 applicant_username 两个参数两选一即可。

​

返回值

• 该API接口请求成功时返回值格式如下：

{
    "status": "success",
    "data": {...}
}

data返回的是创建成功的审批单记录信息。

• 该API接口请求失败时返回值格式如下：

{
    "status": "error",
    "data": { errors: [{ errorMessage: "..." }] }
}

​

暂存审批单

敬请期待…

​

计算下一步处理人

根据当前步骤状态计算下一步可供选择的处理人清单。

​

URI

/api/workflow/nextStepUsers?spaceId=<spaceId>&deal_type=<deal_type>

以下表格描述了URI中的参数清单。

​

请求参数

请求该接口时需要根据URI中传入的不同处理人类型传入不同的参数。

• 处理人类型为指定人员 specifyUser 时需要传入的参数：

• 处理人类型为指定审批岗位 applicantRole 时需要传入的参数：

• 处理人类型为指定角色 hrRole 时需要传入的参数：

• 处理人类型为申请人上级 applicantSuperior 时需要传入的参数：

• 处理人类型为申请人 applicant 时需要传入的参数：

• 处理人类型为指定人员字段 userField 时需要传入的参数：

userField 参数是一个json对象，以下表格描述了该参数的属性清单：

• 处理人类型为指定部门字段 orgField 时需要传入的参数：

orgField 参数是一个json对象，以下表格描述了该参数的属性清单：

• 处理人类型为指定部门 specifyOrg 时需要传入的参数：

• 处理人类型为指定人员字段相关审批岗位 userFieldRole 时需要传入的参数：

userField 参数是一个json对象，以下表格描述了该参数的属性清单：

• 处理人类型为指定部门字段相关审批岗位 orgFieldRole 时需要传入的参数：

orgField 参数是一个json对象，以下表格描述了该参数的属性清单：

• 处理人类型为指定人员 pickupAtRuntime 时不需要传入任何参数，直接返回空数组。

​

返回值

该API接口返回值格式如下：

{
    "nextStepUsers": [...],
    "error": ""
}

其中 nextStepUsers 是一个对象数组，表示下一步可供选择的处理人列表，以下表格描述了该数组中每个处理人信息：

当该API接口执行过程中出现错误时，会以字符串形式返回到 error 键值中。

​

提交草稿中申请单

把草稿状态的申请单提交到下一步骤。

​

URI

/api/workflow/submit

​

请求参数

请求该接口时需要传入以下参数。

以下表格描述了Instances中的对象键值信息：

以下表格描述了 traces 中的对象键值信息：

以下表格描述了 approves 中的对象键值信息：

traces 是每个步骤的签核历程，approves 则是每个签核历程中的审批历程，里面记录了详细的审批表单信息。

​

返回值

• 该API接口请求成功时返回值格式如下：

{
    "result": [...]
}

result中返回的是一个对象数组，该数组中包含的键值信息如下所示：

alerts中主要是提示流程版本是否已升级。

• 该API接口请求失败时返回值格式如下：

{
    errors: [{ errorMessage: "..." }]
}

​

提交审批中申请单

把审批中的申请单提交到下一步骤。

​

URI

/api/workflow/engine

​

请求参数

请求该接口时需要传入以下参数。

以下表格描述了Approvals中的对象键值信息：

以下表格描述了next_steps中的对象键值信息：

以下表格描述了judge数据字典：

​

返回值

• 该API接口请求成功时返回空对象。

• 该API接口请求失败时返回值格式如下：

{
    errors: [{ errorMessage: "..." }]
}