流程实例

注意

此旧版宜搭API接口文档已于2021年10月15日迁移到**历史文档（不推荐）**目录，已经接入的用户可继续使用，正在准备接入宜搭的用户请查看新版宜搭API。

1. 发起流程

接口: /yida_vpc/process/startInstance.json

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hexxxx	在应用数据中获取。
userId	钉钉的userId	是
language	语言环境	否	zh_CN	可选值：zh_CN/en_US
processCode	流程code	是	TPROC--EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ4	单独发起页链接上可查
formUuid	表单ID	是	FORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3	单独发起页链接上可查
formDataJson	表单数据	是	参考：附录1保存/更新表单数据格式说明
deptId	发起人所在部门号	否	18295	不填，默认发起人主职部门

返回值

result : 实例ID;

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

返回示例

{
   "result":"f30233fb-72e1-4af4-8cb8-c7e0ea9ee530",
   "success":true
}

2. 根据条件搜索流程实例ID

接口：/yida_vpc/process/getInstanceIds.json

说明：只有应用管理员才能使用这个接口

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hexxxx	在应用数据中获取。
userId	钉钉的userId	是
language	语言	否	zh_CN	可选值：zh_CN/en_US默认：zh_CN
formUuid	表单ID	是	FORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3
searchFieldJson	根据表单内组件值查询	否	格式见附录2：根据组件值进行条件搜索，组件值格式说明
taskId	任务ID	否	2199132092	一般用不到。
instanceStatus	实例状态	否	RUNNING	可选值为：RUNNING,TERMINATED,COMPLETED,ERROR。分别代表：运行中，已终止，已完成，异常。
approvedResult	流程审批结果	否	agree	可选值为：agree, disagree。分别表示：同意，拒绝。
currentPage	当前页	否	1	必须大于0默认1
pageSize	每页记录数	否	10	必须大于0默认10不能大于100
originatorId	根据流程发起人工号查询	否
createFrom	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表	否	2018-01-01	字符串格式，且为yyyy-MM-DD格式yyyy-MM-DD
createTo	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表。	否	2018-02-01	字符串格式，且为yyyy-MM-DD格式。和createFrom一起，相当于查询在2018-01-01到2018-01-31之间(包含01和31号)创建的数据。
modifiedFrom	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表	否	2018-01-01	字符串格式，且为yyyy-MM-DD格式
modifiedTo	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表。	否	2018-02-01	字符串格式，且为yyyy-MM-DD格式。和modifiedFrom一起，相当于查询在 2018-01-01到2018-01-31之间(包含01和31号)被修改的数据。

返回值

result : 实例ID;

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

返回示例

{
   "result":{
      "data":[
         "f30233fb-72e1-4af4-8cb8-c7e0ea9ee530",
         "bc0950a3-fe1b-459c-b6ba-282be38523ab",
         "f540cbd7-43eb-40de-b915-6716578a2802"
      ],
      "totalCount":3,
      "currentPage":1
   },
   "success":true
}

3. 根据搜索条件获取实例详情列表

接口：/yida_vpc/process/getInstances.json

说明：只有应用管理员才能使用这个接口

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	helxxxy	在应用数据中获取。
userId	钉钉的userId	是
language	语言	否	zh_CN	可选值：zh_CN/en_US默认：zh_CN
formUuid	表单ID	是	FORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3
searchFieldJson	根据表单内组件值查询	否	格式见附录2：根据组件值进行条件搜索，组件值格式说明
taskId	任务ID	否	2199132092	一般用不到。
instanceStatus	实例状态	否	RUNNING	可选值为：RUNNING,TERMINATED,COMPLETED,ERROR。分别代表：运行中，已终止，已完成，异常。
approvedResult	流程审批结果	否	agree	可选值为：agree, disagree。分别表示：同意，拒绝。
currentPage	当前页	否	1	必须大于0默认1
pageSize	每页记录数	否	10	必须大于0默认10不能大于100
originatorId	根据流程发起人工号查询	否
createFrom	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表	否	2018-01-01	字符串格式，且为yyyy-MM-DD格式
createTo	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表。	否	2018-02-01	字符串格式，且为yyyy-MM-DD格式。和createFrom一起，相当于查询在2018-01-01到2018-01-31之间(包含01和31号)创建的数据。
modifiedFrom	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表	否	2018-01-01	字符串格式，且为yyyy-MM-DD格式
modifiedTo	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表。	否	2018-02-01	字符串格式，且为yyyy-MM-DD格式。和modifiedFrom一起，相当于查询在 2018-01-01到2018-01-31之间(包含01和31号)被修改的数据。

返回值

result :

currentPage : 当前页

totalCount : 符合条件的实例总数

data : 实例详情列表

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

4. 根据实例ID获取流程实例详情

接口：/yida_vpc/process/getInstanceById.json

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hexxyy	在应用数据中获取。
userId	钉钉的userId	是
language	语言	否	zh_CN	可选值：zh_CN/en_US默认：zh_CN
processInstanceId	流程实例ID	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530

返回值

result : 实例详情

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

5. 删除流程实例

接口：/yida_vpc/process/deleteInstance.json

说明：只有应用管理员才能使用这个接口

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hexxxx	在应用数据中获取。
userId	钉钉的userId	是
language	语言	否	zh_CN	可选值：zh_CN/en_US默认：zh_CN
processInstanceId	流程实例ID	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530

返回值

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

6. 终止流程实例

接口：/yida_vpc/process/terminateInstance.json

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hexxxx	在应用数据中获取。
userId	钉钉的userId	是
language	语言	否	zh_CN	可选值：zh_CN/en_US默认：zh_CN
processInstanceId	流程实例ID	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530

返回值

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

7. 根据实例ID批量获取流程实例详情

接口：/yida_vpc/process/getInstancesByIds.json

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hexxyy	在应用数据中获取。
userId	钉钉的userId	是
language	语言	否	zh_CN	可选值：zh_CN/en_US默认：zh_CN
processInstanceIds	流程实例ID列表，多个用,分割	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530,d230233fb-72e1-4af4-8cb8-c7e0ea9ee530

返回值

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

result : 实例详情列表；

8. 执行单个任务接口

接口：/yida_vpc/task/executeTask.json

参数：

参数	描述	是否必填	示例值	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hexxyy	在应用数据中获取。
userId	钉钉的userId	是
language	语言	否	zh_CN	可选值：zh_CN/en_US默认：zh_CN
taskId	任务ID	是	12002575
procInstId	实例ID	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530
outResult	审批结果	是	AGREE	AGREE(同意)、DISAGREE(不同意)
remark	审批意见	是	确认同意
formDataJson	更新的表单值	否	参考：附录1保存/更新表单数据格式说明。参数有的组件更新，没有的组件保持不变。明细的值只能统一更新，无法只更新明细下某个组件的值
noExecuteExpressions	是否不执行校验&关联操作	否	y	本任务节点有绑定校验规则或者关联操作时，y -> 不执行校验规则&关联操作n -> 执行校验规则&关联操作不传默认为n，即会执行校验规则&关联操作

返回值

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

9. 获取审批记录

接口：/yida_vpc/process/getOperationRecords.json

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hexxyy	在应用数据中获取。
userId	钉钉的userId	是
language	语言	否	zh_CN	可选值：zh_CN/en_US默认：zh_CN
processInstanceId	流程实例ID	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530

返回值

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

返回示例

{
  "success": true,
  "content": [
    {
      "operateTime": "2018-06-22 14:35:40",
      "remark": "",
      "taskHoldTime": 0,
      "type": "HISTORY",
      "operatorName": "王XX",
      "operator": "WB260752",
      "activityId": "sid-restartevent",
      "action": "提交申请",
      "actionExt": "submit",
      "id": 2846866118,
      "operatorPhotoUrl": "//work.alibaba-inc.com/photo/WB260752.128x128.jpg",
      "processInstanceId": "8c124808-82e7-473b-9a7a-43c29b310837",
      "showName": "提交申请",
      "operateType": "NEW_PROCESS",
      "domains": [],
      "operatorStatus": "A",
      "operatorAgentIds": [],
      "size": 1,
      "operatorDisplayName": "王XX",
      "taskId": "null"
    },
    {
      "taskHoldTime": 531398377,
      "type": "TODO",
      "operatorName": "王XX",
      "operator": "WB260752",
      "activityId": "sidJIOB2P2J1JW3RPMDOS28",
      "taskType": "COMMON_ALL_AT_ONCE",
      "actionExt": "doing",
      "operatorPhotoUrl": "//work.alibaba-inc.com/photo/WB260752.128x128.jpg",
      "processInstanceId": "8c124808-82e7-473b-9a7a-43c29b310837",
      "showName": "执行人",
      "activeTime": "2018-06-22 14:35:41",
      "domains": [],
      "operatorStatus": "A",
      "operatorAgentIds": [],
      "size": 1,
      "operatorDisplayName": "王XX",
      "taskId": "2846866145"
    }
  ]
}

10. 执行虚拟节点任务

接口: /yida_vpc/process/executePlatformTask.json

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hexxyyddd	在应用数据中获取。
userId	钉钉的userId	是	yida_pub_account	写死 yida_pub_account
language	语言	否	zh_CN	可选值：zh_CN/en_US默认：zh_CN
procInstId	流程实例ID	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530
outResult	审批结果	是	agreedisagree
formDataJson	更新的表单数据	否	参考：附录1保存/更新表单数据格式说明。参数有的组件更新，没有的组件保持不变。明细的值只能统一更新，无法只更新明细下某个组件的值
remark	审批意见	是	确认同意
noExecuteExpressions	是否不执行校验&关联操作	否	y	本任务节点有绑定校验规则或者关联操作时，y -> 不执行校验规则&关联操作n -> 执行校验规则&关联操作不传默认为n，即会执行校验规则&关联操作

返回值

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

11. 流程实例更新

接口: /yida_vpc/process/updateInstance.json

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hello1234	在应用数据中获取。
userId	钉钉的userId	是	会校验userId是否有流程发起权限
language	语言环境	否	zh_CN	可选值：zh_CN/en_US
processInstanceId	实例ID	是
updateFormDataJson	更新的表单数据	是	参考：附录1保存/更新表单数据格式说明

返回值

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

12.获取流程设计节点上的按钮列表

接口: /yida_vpc/process/getActivityButtonVOs.json

参数：

参数	描述	是否必填	示例	备注
appType	应用ID	是	APP_PBKT0MFBEBTDO8T7SLVP
systemToken	应用秘钥	是	hello1234	在应用数据中获取。
userId	钉钉的userId	是	会校验userId是否有流程发起权限
language	语言环境	否	zh_CN	可选值：zh_CN/en_US
processCode	流程编码	是	TPROC--X1G***42ZMGA31OYELIWJ1
activityId	节点ID	是

返回值

success : 请求是否成功;

errorMsg : 错误信息;

errorCode : 错误码;

返回示例

{
  "result": [
    {
      "aliasEn": "Forward",
      "alias": "转交",
    },
    {
      "aliasEn": "Append",
      "alias": "加签",
    },
    {
      "aliasEn": "Return",
      "alias": "退回",
    }
  ],
  "success": true,
  "errorCode": null,
  "content": null,
  "errorMsg": null
}

1. 发起流程#

2. 根据条件搜索流程实例ID#

3. 根据搜索条件获取实例详情列表#

4. 根据实例ID获取流程实例详情#

5. 删除流程实例#

6. 终止流程实例#

7. 根据实例ID批量获取流程实例详情#

8. 执行单个任务接口#

9. 获取审批记录#

10. 执行虚拟节点任务#

11. 流程实例更新#

12.获取流程设计节点上的按钮列表#

1. 发起流程

2. 根据条件搜索流程实例ID

3. 根据搜索条件获取实例详情列表

4. 根据实例ID获取流程实例详情

5. 删除流程实例

6. 终止流程实例

7. 根据实例ID批量获取流程实例详情

8. 执行单个任务接口

9. 获取审批记录

10. 执行虚拟节点任务

11. 流程实例更新

12.获取流程设计节点上的按钮列表