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

基本信息中文名： 根据搜索条件获取实例详情列表
接口名： /yida/process/getInstances.json
所在目录： 宜搭流程
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
modifiedFrom	String	否	2018-01-01	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表。 字符串格式，目前支持yyyy-MM-dd和yyyy-MM-dd HH:mm:ss 两种日期格式。
formUuid	String	是	FORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3	表单ID
systemToken	String	是		应用秘钥
pageSize	Int	否	10	每页记录数，必须大于0，默认值10
searchFieldJson	String	否		根据表单内组件值查询，格式见附录：根据组件值进行条件搜索，组件值格式说明
language	String	否	zh_CN	语言,可选值：zh_CN/en_US 默认：zh_CN
instanceStatus	String	否	RUNNING	实例状态。可选值为：RUNNING,TERMINATED,COMPLETED,ERROR。 分别代表：运行中，已终止，已完成，异常。
userId	String	是		登录人的工号
createFrom	String	否	2018-01-01	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表。 字符串格式，目前支持yyyy-MM-dd和yyyy-MM-dd HH:mm:ss 两种日期格式。
targetFieldJson	String	否	[“textField_jf9a8cqs”,“employeeField_jf9a78un”]	想获取的表单组件值[“fieldId”…]
approvedResult	String	否	agree	流程审批结果。可选值为：agree, disagree。 分别表示：同意， 拒绝。
createTo	String	否	2018-02-01	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表。 字符串格式，目前支持yyyy-MM-dd和yyyy-MM-dd HH:mm:ss 两种日期格式。 和createFrom一起，相当于查询在2018-01-01到2018-01-31之间(包含01和31号)创建的数据。
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
originatorId	String	否		流程发起人工号
currentPage	Int	否	1	当前页。必须大于0，默认值1.
taskId	String	否		任务ID
modifiedTo	String	否	2018-02-01	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表。 字符串格式，目前支持yyyy-MM-dd和yyyy-MM-dd HH:mm:ss 两种日期格式。和modifiedFrom一起，相当于查询在2018-01-01到2018-01-31之间(包含01和31号)被修改的数据。

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
result
└currentPage	Int	当前页
└totalCount	Int	符合条件的实例总数
└data	List	实例详情列表数组，单个实例详情格式参见：附录-流程实例详情对象格式说明
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

根据实例ID获取流程实例详情基本信息中文名： 根据实例ID获取流程实例详情
接口名： /yida/process/getInstanceById.json
所在目录： 宜搭流程
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
processInstanceId	String	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530	流程实例ID
formUuid	String	否		表单id
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN。
userId	String	是		登录人的工号

返回参数

参数	说明
result	实例详情列表，实例详情格式参见：附录-流程实例详情对象格式说明
success	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	错误码。仅发生错误时显示
errorMsg	错误信息。仅发生错误时显示

删除流程实例基本信息中文名： 删除流程实例
接口名： /yida/process/deleteInstance.json
所在目录： 宜搭流程
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
processInstanceId	String	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530	流程实例id
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN。
userId	String	是		登录人工号

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

终止流程实例基本信息中文名： 终止流程实例
接口名： /yida/process/terminateInstance.json
所在目录： 宜搭流程
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
processInstanceId	String	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530	流程实例id
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN。
userId	String	是		登录人工号

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

执行单个任务接口基本信息中文名： 执行单个任务接口
接口名： /yida/task/executeTask.json
所在目录： 宜搭流程
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
outResult	java.lang.String	是	AGREE	审批结果，可选值：AGREE(同意)、DISAGREE(不同意)。
appType	java.lang.String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
formDataJson	java.lang.String	否		更新的表单值， 参考：附录 保存/更新表单数据格式说明。参数有的组件更新，没有的组件保持不变。明细的值只能统一更新，无法只更新明细下某个组件的值
systemToken	java.lang.String	是		应用秘钥
remark	java.lang.String	是		审批意见，例如“确认同意”。
language	java.lang.String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN。
procInstId	java.lang.String	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530	流程实例id
userId	java.lang.String	是		登录人的工号
taskId	java.lang.Long	是	12002575	任务ID

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

转交审批任务基本信息中文名： 转交审批任务
接口名： /yida/task/redirectTask.json
所在目录： 宜搭流程
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
processInstanceId	String	是		流程实例id
formUuid	String	否		表单id
byManager	String	是	y	是否应用管理员进行转交 ●可选项 : y/n ●y,则userId必须传应用管理员工号，或者yida_pub_account ●n, userId必须传任务的当前执行人
appType	String	是		应用ID
systemToken	String	是		应用秘钥
nowActionerId	String	是		转交后新的任务处理人的工号
remark	String	是		转交备注
language	String	否	zh_CN	语言环境，可选值：zh_CN/en_US
userId	String	是		登录人的工号
taskId	Long	是		任务id

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

获取审批记录基本信息中文名： 获取审批记录
接口名： /yida/process/getOperationRecords.json
所在目录： 宜搭流程
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
processInstanceId	String	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530	流程实例ID
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN。
userId	String	是		登录人的工号

返回参数返回字段说明：

名称	描述
result	审批记录列表
└id	主键Id
└processInstanceId	对应流程实例Id
└taskId	对应任务Id
└showName	节点名称
└activityId	节点定义ID
└operator	操作人
└operatorNick	操作人花名
└operatorName	操作人真名
└operatorDisplayName	操作人国际化显示名
└operatorStatus	操作人状态
└operateTime	操作时间
└action	执行动作
└remark	备注
└taskType	任务类型: 普通的任务类型 COMMON 中间插入的任务类型 MIDDLE_IN
└taskExecuteType	任务执行类型
└files	附件保存的文件
└operatorAgentIds	代理人
└operateType	操作类型
└activeTime	任务激活时间
└taskHoldTime	任务滞留时间
└operatorPhotoUrl	人员头像
└size	固定值1
└type	固定值HISTORY
success	请求是否成功。可选值 TRUE 请求成功；false 请求失败
errorCode	错误码。仅发生错误时显示。
errorMsg	错误信息。仅发生错误时显示。

执行虚拟节点任务基本信息中文名： 执行虚拟节点任务
接口名： /yida/process/executePlatformTask.json
所在目录： 宜搭流程
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
outResult	String	是		审批结果。可选值：agree/disagree
appType	String	是		应用ID
formDataJson	String	否		更新的表单数据，参考：附录保存/更新 表单数据格式说明。 参数有的组件更新，没有的组件保持不变。 明细的值只能统一更新，无法只更新明细下某个组件的值
systemToken	String	是		应用秘钥
remark	String	是		审批意见，例如“确认同意”。
language	String	否		语言，可选值：zh_CN/en_US 默认：zh_CN。
procInstId	String	是		流程实例ID
userId	String	是	yida_pub_account	登录人工号，固定yida_pub_account

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

流程实例更新基本信息中文名： 流程实例更新
接口名： /yida/process/updateInstance.json
所在目录： 宜搭流程
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
processInstanceId	String	是		流程实例ID
updateFormDataJson	String	是		更新的表单数据。参考：附录保存/更新 表单数据格式说明
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
ignoreEmpty	Boolean	否		是否忽略空值。
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言，可选值：zh_CN/en_US
userId	String	是		登录人的员工工号，会校验userId是否有流程发起权限

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

获取流程设计节点上的按钮列表基本信息中文名： 获取流程设计节点上的按钮列表
接口名： /yida/process/getActivityButtonVOs.json
所在目录： 宜搭流程
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
activityId	String	是	sidKDYN9BIP***4K06T8G7	节点ID，可以通过/yida/process/getOperationRecords.json 接口返值中的activityId字段获取
processCode	String	是	TPROC–X1G***42ZMGA31OYELIWJ1	流程编码。
appType	String	是		应用ID
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言。可选值：zh_CN/en_US
userId	String	是		登录人的员工工号，会校验userId是否有流程发起权限

返回参数

名称	类型	描述
result	List	按钮显示的中英文描述
└aliasEn	String	按钮显示英文
└alias	String	按钮显示中文
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

退回审批到指定节点基本信息中文名： 退回审批到指定节点
接口名： /yida/task/restartInstance.json
所在目录： 宜搭流程
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
targetActivityId	String	否	sidKF6M***A2JNF20DD4CC4	目标流程节点的id，如果为空则退回到提交人节点
processInstanceId	String	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530	流程实例ID
formUuid	String	否	FORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB	表单编码
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用编码
systemToken	String	是		应用秘钥
files	String	否		附件文件地址列表，JSON数组格式
currentActivityId	String	是	sidKF6M***A2JNF20DD4CC4	当前流程节点的id
remark	String	否		评论
language	String	否	zh_CN	语言，可选值：zh_CN/en_US
userId	String	是		用户id，会校验userId是否有流程发起权限
taskId	String	是	9905037	任务id

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

执行加签操作基本信息中文名： 执行加签操作
接口名： /yida/task/appendTask.json
所在目录： 宜搭流程
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
procInsId	String	是	f30233fb-72e1-4af4-8cb8-c7e0ea9ee530	流程实例id
actioners	String[]	是	[“1234”,“2345”]	加签操作人列表
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用编码
systemToken	String	是		应用秘钥
remark	String	否		评论
language	String	否	zh_CN	语言，可选值：zh_CN/en_US
userId	String	是		用户id，会校验userId是否有流程发起权限
taskId	Long	是	9905037	任务id
isBefore	Boolean	是	true	是否为前加签

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

宜搭表单新增单据实例基本信息中文名： 新增单据实例
接口名： /yida/form/saveFormData.json
所在目录： 宜搭表单
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
formUuid	java.lang.String	是	FORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB	表单ID
appType	java.lang.String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
formDataJson	java.lang.String	是	{“textField_jcpm6agt”: “单行”,“employeeField_jcos0sar”: [“workno”]}	表单数据，参考：附录 保存/更新 表单数据格式说明
systemToken	java.lang.String	是		应用秘钥
language	java.lang.String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN
userId	java.lang.String	是		登录人的工号，校验userId是否有单据提交权限

返回参数

名称	类型	描述
result	String	新创建的表单示例ID
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

更新单据中指定组件值基本信息中文名： 更新单据中指定组件值
接口名： /yida/form/updateFormData.json
所在目录： 宜搭表单
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
updateFormDataJson	String	是	{“employeeField_jcpm5gy2”: [“workno”]}	要更新的表单组件值，参考：附录 保存/更新 表单数据格式说明。 参数有的组件更新，没有的组件保持不变。 明细的值只能统一更新，无法只更新明细下某个组件的值
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
formInstId	String	是	FINST-NJYJZELVVYZRVGJHR7M6FJW3ESJN1P1TCNPCJ9	表单实例id
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN
userId	String	是		登录人的工号，校验userId是否有更新权限

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

删除单据实例基本信息中文名： 删除单据实例
接口名： /yida/form/deleteFormData.json
所在目录： 宜搭表单
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
appType	String	是		应用ID
formInstId	String	是		要删除的表单数据ID
systemToken	String	是		应用秘钥
language	String	否		语言可选值：zh_CN/en_US 默认：zh_CN
userId	String	是		登录人工号
formUuid	String	否		表单id

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

根据单据实例ID查询单据实例详情基本信息中文名： 根据单据实例ID查询单据实例详情
接口名： /yida/form/getFormDataById.json
所在目录： 宜搭表单
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
formInstId	String	是	FINST-NJYJZELVVYZRVGJHR7M6FJW3ESJN1P1TCNPCJ9	要查询的实例的实例ID
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN。
userId	String	是		登录人的工号

返回参数

名称	类型	描述
result	Object	单据实例详情。详细的字段描述参见：附录 单据实例详情对象格式说明
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

根据条件搜索单据实例ID列表基本信息中文名： 根据条件搜索单据实例ID列表
接口名： /yida/form/searchFormDataIds.json
所在目录： 宜搭表单
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
modifiedFrom	String	否	2018-01-01	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表 字符串格式，目前支持yyyy-MM-dd和yyyy-MM-dd HH:mm:ss 两种日期格式。
formUuid	String	是	FORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3	表单ID
systemToken	String	是		应用秘钥
pageSize	int	否	10	每页记录数，必须大于0，默认值10
searchFieldJson	String	否		根据表单内组件值查询，格式见附录：根据组件值进行条件搜索，组件值格式说明
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN。
userId	String	是		登录人的工号，校验userId是否应用管理员，不是报错
createFrom	String	否	2018-01-01	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表。 字符串格式，目前支持yyyy-MM-dd和yyyy-MM-dd HH:mm:ss 两种日期格式。
createTo	String	否	2018-02-01	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表。 字符串格式，目前支持yyyy-MM-dd和yyyy-MM-dd HH:mm:ss 两种日期格式。和createFrom一起，相当于查询在2018-01-01到2018-01-31之间(包含01和31号)创建的数据。
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
originatorId	String	否		数据提交人工号
currentPage	Int	否	1	当前页，必须大于0，默认值1。
modifiedTo	String	否	2018-02-01	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表。 字符串格式，目前支持yyyy-MM-dd和yyyy-MM-dd HH:mm:ss 两种日期格式。和modifiedFrom一起，相当于查询在2018-01-01到2018-01-31之间(包含01和31号)被修改的数据。

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
result
└currentPage	Int	当前页
└totalCount	Int	符合条件的实例总数
└data	List	实例id列表
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

根据条件搜索单据实例详情列表基本信息中文名： 根据条件搜索单据实例详情列表
接口名： /yida/form/searchFormDatas.json
所在目录： 宜搭表单
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
modifiedFrom	String	否	2018-01-01	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表
formUuid	String	是	FORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3	表单ID
systemToken	String	是		应用秘钥
pageSize	Int	否	10	每页记录数，必须大于0，默认值10。
searchFieldJson	String	否		根据表单内组件值查询 格式见附录：根据组件值进行条件搜索，组件值格式说明
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN
userId	String	是		登录人的工号
createFrom	String	否	2018-01-01	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表
createTo	String	否	2018-02-01	createFrom和createTo两个时间构造一个时间段。查询在该时间段创建的数据列表。
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
originatorId	String	否		根据数据提交人工号查询
currentPage	Int	否	1	当前页，必须大于0，默认值1
modifiedTo	String	否	2018-02-01	modifiedFrom和modifiedTo构成一个时间段，查询在该时间段有修改的数据列表。

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
result
└currentPage	Int	当前页
└totalCount	Int	符合条件的实例总数
└data	List	实例详情列表数组。单个实例详情格式参见：附录 单据实例详情对象格式说明
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

获取表单定义基本信息中文名： 获取表单定义
接口名： /yida/formDesign/getFormComponentDefinationList.json
所在目录： 宜搭表单
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
formUuid	String	是	FORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB	表单ID
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN。
userId	String	是		登录人的工号

返回参数

名称	类型	描述
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
result		表单中的控件描述信息列表
└label	String	控件的中英文标签信息
└key	String	控件的唯一标识
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

宜搭任务中心查询已提交任务基本信息中文名： 查询已提交任务
接口名： /yida/process/getMySubmmitInCorp.json
所在目录： 宜搭任务中心
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
taskFinishTo	Long	否		任务结束时间
corpId	String	是		企业ID
instanceCreateFrom	Long	否		实例创建开始时间，13位以毫秒为单位的时间戳
language	String	否		语言环境，可选值：zh_CN/en_US
userId	String	是		登录人的工号
token	String	否		企业维度的验权token md5(corpId + userId + code)，每个企业有自己的唯一codemd5取32位大写值特别说明：用于企业级别验权的code参数平台暂未透出，后面优化后会透出，当前阶段可以提供租户编码从宜搭值班同学侧获取。
createFrom	Long	否		创建开始时间，13位以毫秒为单位的时间戳
processCodes	String	否	[“xx”,“xxx”]	流程code列表
taskFinishFrom	Long	否		任务结束时间
createTo	Long	否		创建结束时间，13位以毫秒为单位的时间戳
limit	Int	是	10	每页记录数，必须大于0，默认值10
page	Int	是	1	当前页，必须大于0，默认值1
appTypes	String	否	[“APP_xxx”,“APP_xxx”]	应用标识列表
keyword	String	否		查询关键词
instanceCreateTo	Long	否		实例创建结束时间，13位以毫秒为单位的时间戳
status	String	否		查询状态

返回参数

名称
result	返回内容
└ data
└ └formInstanceId	表单示例id
└ └title	标题
└ └instValue	表单中的控件描述信息
└ └processId	流程实例id
└ └appType	应用编码
└ └dataMap	数据映射表，key为控件唯一id，value为控件值
└ └originatorId	发起人的id
└ └formUuid	表单id
└└ dataType	类型，其中finst表示流程。
└ └originatorAvatar	头像
└ └version	版本号
└ └createTime	创建时间
└ └modifiedTime	修改时间
└ totalCount	符合条件的实例总数
└ currentPage	当前页
success	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	错误码。仅发生错误时显示。
errorMsg	错误信息。仅发生错误时显示。

查询待办任务基本信息中文名： 查询待办任务
接口名： /yida/process/getTodoTasksInCorp.json
所在目录： 宜搭任务中心
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
taskFinishTo	Long	否		任务创建结束时间
corpId	String	是		企业ID or 租户编码
instanceCreateFrom	Long	否		实例创建开始时间
language	String	否	zh_CN	语言，可选值：zh_CN/en_US
userId	String	是		当前登录人的工号
token	String	否		企业维度的验权token md5(corpId + userId + code)，每个企业有自己的唯一code md5取32位大写值 特别说明：用于企业级别验权的code参数平台暂未透出，后面优化后会透出，当前阶段可以提供租户编码从宜搭值班同学侧获取。
createFrom	Long	否		创建开始时间，13位以毫秒为单位的时间戳
processCodes	String	否		流程code列表
taskFinishFrom	Long	否		任务结束时间
createTo	Long	否		创建结束时间，13位以毫秒为单位的时间戳
limit	Int	是	10	每页记录数，必须大于0，默认值10
page	Int	是	1	页码，必须大于0，默认值1
appTypes	String	否	[“APP_xxx”,“APP_xxx”]	应用标识列表
keyword	String	否		查询关键词
instanceCreateTo	Long	否		实例创建开始时间
status	String	否		查询状态

返回参数

名称	描述
result	返回内容
└ data
└└ processInstanceId	流程实例id
└└ originatorName	发起人的中文名
└└ title	流程实例的中文标题
└└ originatorPhoto	发起人的头像
└└ titleEn	流程实例的英文标题
└└ createTime	流程实例的发起时间
└└ appType	应用编码
└└ originatorNameEn	发起人的英文名
└└ originatorId	发起人的userid
└└ taskId	任务id
└└ status	任务状态，其中NEW表示新发起的流程
└ totalCount	符合条件的实例总数
└ currentPage	当前页
success	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	错误码。仅发生错误时显示。
errorMsg	错误信息。仅发生错误时显示。

查询已完成任务基本信息中文名： 查询已完成任务
接口名： /yida/process/getDoneTasksInCorp.json
所在目录： 宜搭任务中心
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
taskFinishTo	Long	否		任务完成时间
corpId	String	是		租户编码 or 企业ID
instanceCreateFrom	Long	否		实例创建开始时间
language	String	否	zh_CN	语言，可选值：zh_CN/en_US
userId	String	是		当前登录用户的工号
token	String	否		企业维度的验权token md5(corpId + userId + code)，每个企业有自己的唯一code md5取32位大写值 特别说明：用于企业级别验权的code参数平台暂未透出，后面优化后会透出，当前阶段可以提供租户编码从宜搭值班同学侧获取。
createFrom	Long	否		创建开始时间
processCodes	String	否		流程code列表
taskFinishFrom	Long	否		任务结束时间
createTo	Long	否		创建结束时间
limit	Int	是	10	每页记录数，必须大于0，默认值10
page	Int	是	1	页码，必须大于0，默认值1
appTypes	String	否	[“APP_xxx”,“APP_xxx”]	应用标识列表
keyword	String	否		查询关键词
instanceCreateTo	Long	否		实例创建开始时间
status	String	否		查询状态

返回参数

名称	描述
result	返回内容
└ data
└└ processInstanceId	流程的完成时间
└└ finishTime	流程实例id
└└ originatorName	发起人的中文名
└└ title	流程实例的中文标题
└└ originatorPhoto	发起人的头像
└└ titleEn	流程实例的英文标题
└└ createTime	流程实例的发起时间
└└ appType	应用编码
└└ originatorNameEn	发起人的英文名
└└ originatorId	发起人的userid
└└ taskId	任务id
└└ status	任务状态，其中COMPLETED表示已完成。
└ totalCount	符合条件的实例总数
└ currentPage	当前页
success	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	错误码。仅发生错误时显示。
errorMsg	错误信息。仅发生错误时显示。

宜搭其他宜搭附件地址转临时免登地址基本信息中文名： 宜搭附件地址转临时免登地址
接口名： /yida/file/getOpenUrl.json
所在目录： 宜搭其他
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
systemToken	String	是		应用秘钥
fileUrl	String	是	https://yida.alibaba-inc.com/fileHandle?appType=APP_VN7I6HVKUTXES7XX4OI8&fileName=2a4103a6-44d5-4114-990d-4147a2d53811.xlsx&instId=&type=download	宜搭附件地址
language	String	否		语言，可选值：zh_CN/en_US 默认：zh_CN
userId	String	是		登录人的工号
timeout	Long	是	60000	临时地址多久失效,单位毫秒，60000表示一分钟后临时地址失效

返回参数

名称	类型	描述
result	String	免登的附件地址
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

增加评论基本信息中文名： 增加评论
接口名： /yida/remark/save.json
所在目录： 宜搭其他
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
formInstId	String	是		表单实例ID
replyId	Long	否	12	对评论ID进行回复
systemToken	String	是		应用秘钥
language	String	否		语言，可选值：zh_CN/en_US 默认：zh_CN。
atUserId	String	否	“123”,“234”	将评论内容通过钉钉发给指定用户。多个工号,用英文逗号分隔。
userId	String	是		评论人工号
content	String	是		评论的内容
images	List	否	[{“extName”:“png”,“fileName”:“宜搭 头像.png”,“width”:“”,“height”:“”,“imageUrl”:“https://yida.alibaba-inc.com/fileHandle?appType=APP_VA86G5ZSXWO62NO2JH9D&fileName=2328bf5c-c35f-40a9-9560-351259119dfc.png&instId=&type=open",“thumbnail”:“https://yida.alibaba-inc.com/fileHandle?appType=APP_VA86G5ZSXWO62NO2JH9D&fileName=2328bf5c-c35f-40a9-9560-351259119dfc.png&instId=&type=open”,“id”:null,“type”:“IMG”,“ownedObjType”:"”}]	图片 关键参数imageUrl
files	List	否	[{“extName”:“png”,“fileName”:“宜搭 头像.png”,“downloadUrl”:“https://yida.alibaba-inc.com/fileHandle?appType=APP_VA86G5ZSXWO62NO2JH9D&fileName=ce606b82-a8af-417a-bc34-61aca810caed.png&instId=&type=download",“previewUrl”:“https://yida.alibaba-inc.com/fileHandle?appType=APP_VA86G5ZSXWO62NO2JH9D&fileName=ce606b82-a8af-417a-bc34-61aca810caed.png&instId=&type=open”,“type”:"OTHER”}]	附件 关键参数downloadUrl

返回参数

名称	类型	描述
result	Long	新增评论的ID
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

查询评论列表基本信息中文名： 查询评论列表
接口名： /yida/remark/list.json
所在目录： 宜搭其他
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
formUuid	String	否		表单id
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
formInstId	String	是	FINST-NJYJZELVVYZRVGJHR7M6FJW3ESJN1P1TCNPCJ9	表单实例id
systemToken	String	是		应用秘钥
language	String	否	zh_CN	语言，可选值：zh_CN/en_US 默认：zh_CN
userId	String	是		员工工号
needInstValue	Boolean	否		是否需要实例值

返回参数

名称	描述
success	请求是否成功。可选值：true：请求成功；false：请求失败
content	评论列表
└ creator	创建人
└ images	图片
└ formInstId	表单实例ID
└ files	附件
└ id	实体id，主键
└ gmtCreate	创建时间
└ atUserId	被AT的用户ID
└ content	评论内容

获取应用下所有表单页面的列表基本信息中文名： 获取应用下所有表单页面的列表
接口名： /yida/app/listNavigationByFormType.json
所在目录： 宜搭其他
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
formType	String	是		页面类型.receipt,单据页面 process,流程页面 report，报表页面
appType	String	是	APP_PBKT0MFBEBTDO8T7SLVP	应用ID
systemToken	String	是		应用秘钥
language	String	否		语言，可选值：zh_CN/en_US 默认：zh_CN。
userId	String	是		评论人工号

返回参数

名称	类型	描述
result	List	表单页面列表
└formUuid	String	表单id
└title	String	中英文标题信息
└processCode	String	流程编码，只有当formType选择process流程页面时返回结果才有该字段
success	Boolean	请求是否成功。可选值：true：请求成功；false：请求失败
errorCode	String	错误码。仅发生错误时显示。
errorMsg	String	错误信息。仅发生错误时显示。

评论评论/评论回复基本信息中文名： 评论/评论回复
接口名： /bip/comment/add
所在目录： 评论
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
subjectId	java.lang.String	是		主题id
type	java.lang.String	是		评论类型 0评论 1回复
replyCommentId	java.lang.String	否		父评论id,评论类型为1的时候必填
content	java.lang.String	否		评论内容
subjectAccountId	java.lang.String	是		主题的用户id
subjectAccountTenantId	java.lang.String	是		主题的用户租户id
extendedField	java.lang.String	否		扩展字段

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	List<CommentInfo>		参见补充说明 CommentInfo
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

更新评论/更新评论回复基本信息中文名： 更新评论/更新评论回复
接口名： /bip/comment/update
所在目录： 评论
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
id	Long	是		id
extendedField	java.lang.String	是		扩展字段

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	java.lang.String		成功 true 失败 false
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMessage	java.lang.String		异常信息

根据不同条件查询评论/回复评论基本信息中文名： 根据不同条件查询评论/回复评论
接口名： /bip/comment/query
所在目录： 评论
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
pageNo	Integer	否		页码
pageSize	Integer	否		每页大小
sortBy	java.lang.String	否		排序， 格式：顺序标识+字段，如：根据创建时间倒序：-createTime，多个排序字段已,隔开
subjectId	java.lang.String	否		主题id
subjectIdStr	java.lang.String	否		主题id列表,多个用逗号分隔
commentAccountId	Long	否		发送者id
commentAccountTenantId	Long	否		发送者租户id
subjectAccountId	Long	否		主题发布者id
subjectAccountTenantId	Long	否		主题发布者租户id
type	Integer	否		类型 0评论 1回复
bizCode	java.lang.String	否		bizCode
isPage	Integer	否		是否分页 0 否 1 是 ，默认 0

返回参数1.分页查询返回参数

参数名	含义
content	List<CommentInfo>，参见补充说明
errorCode	异常码
errorMessage	异常信息
errorLevel	错误级别
success	成功 true 失败 false
totalPages	总页数
currentPage	当前页
limit	页面容量
totalCount	总数

2.分页查询返回参数

参数名	含义
content	List<CommentInfo>，参见补充说明
errorCode	异常码
errorMessage	异常信息
errorLevel	错误级别
success	成功 true 失败 false

根据不同条件查询评论/回复评论(限制返回数量)基本信息中文名： 根据不同条件查询评论/回复评论(限制返回数量)
接口名： /bip/comment/limitQueryGroupBySubjectId
所在目录： 评论
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
pageNo	Integer	否		页码
pageSize	Integer	否		每页大小
sortBy	java.lang.String	否		排序， 格式：顺序标识+字段，如：根据创建时间倒序：-createTime，多个排序字段已,隔开
subjectId	java.lang.String	否		主题id
subjectIdStr	java.lang.String	否		主题id列表，多个使用逗分隔
commentAccountId	Long	否		发送者id
commentAccountTenantId	Long	否		发送者租户id
subjectAccountId	Long	否		主题发布者id
subjectAccountTenantId	Long	否		主题发布者租户id
type	Integer	否		类型 0评论 1回复
bizCode	java.lang.String	否		bizCode
limitPerSubject	Integer	否		每个主题的返回数量限制，不填则不限制

返回参数

名称	类型	示例值	描述
success	java.lang.String		success
content	java.lang.String		content具体参见补充说明
errorLevel	java.lang.String		errorLevel
errorCode	java.lang.String		errorCode
errorMsg	java.lang.String		errorMsg

根据条件查询评论数量基本信息中文名： 根据条件查询评论数量
接口名： /bip/comment/countComments
所在目录： 评论
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
pageNo	Integer	否		页码
pageSize	Integer	否		每页大小
sortBy	java.lang.String	否		排序， 格式：顺序标识+字段，如：根据创建时间倒序：-createTime，多个排序字段已,隔开
subjectId	java.lang.String	否		主题id
subjectIdStr	java.lang.String	否		主题id列表,多个用逗号分隔
commentAccountId	Long	否		发送者id
commentAccountTenantId	Long	否		发送者租户id
subjectAccountId	Long	否		主题发布者id
subjectAccountTenantId	Long	否		主题发布者租户id
type	Integer	否		类型 0评论 1回复
bizCode	java.lang.String	否		bizCode

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	Integer		数量
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

根据评论id查询评论基本信息中文名： 根据评论id查询评论
接口名： /bip/comment/get
所在目录： 评论
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
id	Long	是		id

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	List<CommentInfo>		参见补充说明 CommentInfo
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

根据条件删除评论基本信息中文名： 根据条件删除评论
接口名： /bip/comment/deleteByConditions
所在目录： 评论
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
subjectId	java.lang.String	否		主题id
commentAccountId	Long	否		发送者id
commentAccountTenantId	Long	否		发送者租户id
subjectAccountId	Long	否		主题发布者id
subjectAccountTenantId	Long	否		主题发布者租户id
type	Integer	否		类型 0评论 1回复
bizCode	java.lang.String	否		bizCode
id	Long	否		主键id,此条件会忽略除了isRecursion外的其他条件
isRecursion	java.lang.String	否		是否递归删除 0 否 1 是， 默认 0

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	boolean		成功 true 失败 false
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

点赞基本信息中文名： 点赞
接口名： /bip/like/add
所在目录： 评论
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
subjectId	java.lang.String	是		主题id
subjectAccountId	Long	是		主题的用户id
subjectAccountTenantId	Long	是		主题的用户租户id
extendedField	java.lang.String	否		扩展字段
subjectKeyword	java.lang.String	否		主题关键词，搜索使用,V1.1.0之后支持

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	List<LikeInfo>		参见补充说明 LikeInfo
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

更新点赞基本信息中文名： 更新点赞
接口名： /bip/like/update
所在目录： 评论
调用方式： POST（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
id	Long	是		id
extendedField	java.lang.String	是		扩展字段
subjectKeyword	java.lang.String	否		主题关键词，搜索使用,V1.1.0之后支持

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	boolean		成功 true 失败 false
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

根据不同条件查询点赞基本信息中文名： 根据不同条件查询点赞
接口名： /bip/like/query
所在目录： 评论
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
pageNo	Integer	否		页码
pageSize	Integer	否		每页大小
sortBy	java.lang.String	否		排序， 格式：顺序标识+字段，如：根据创建时间倒序：-createTime，多个排序字段已,隔开
subjectId	java.lang.String	否		主题id
subjectIdStr	java.lang.String	否		主题id列表，多个逗号分隔
likeAccountId	Long	否		发送者id
likeAccountTenantId	Long	否		发送者租户id
subjectAccountId	Long	否		主题发布者id
subjectAccountTenantId	Long	否		主题发布者租户id
bizCode	java.lang.String	否		bizCode
isPage	Integer	否		是否分页 0 否 1是 ，默认 0
subjectKeyword	java.lang.String	否		主题关键词，搜索使用,V1.1.0之后支持

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	List<LikeInfo>		参见补充说明 LikeInfo
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

根据不同条件查询点赞,并限制返回数量，根据主题id分类基本信息中文名： 根据不同条件查询点赞,并限制返回数量，根据主题id分类
接口名： /bip/like/limitQueryGroupBySubjectId
所在目录： 评论
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
sortBy	java.lang.String	否		排序， 格式：顺序标识+字段，如：根据创建时间倒序：-createTime，多个排序字段已,隔开
subjectId	java.lang.String	否		主题id
subjectIdStr	java.lang.String	否		主题id列表，多个使用逗号分隔
likeAccountId	Long	否		发送者id
likeAccountTenantId	Long	否		发送者租户id
subjectAccountId	Long	否		主题发布者id
subjectAccountTenantId	Long	否		主题发布者租户id
bizCode	java.lang.String	否		bizCode
subjectKeyword	java.lang.String	否		主题关键词，搜索使用,V1.1.0之后支持
limitPerSubject	Integer	否		每个主题返回的点赞数量限制,不填则不限制

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	List		参见补充说明
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

根据条件查询点赞数量基本信息中文名： 根据条件查询点赞数量
接口名： /bip/like/countLike
所在目录： 评论
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
sortBy	java.lang.String	否		排序， 格式：顺序标识+字段，如：根据创建时间倒序：-createTime，多个排序字段已,隔开
subjectId	java.lang.String	否		主题id
likeAccountId	Long	否		发送者id
likeAccountTenantId	Long	否		发送者租户id
subjectAccountId	Long	否		主题发布者id
subjectAccountTenantId	Long	否		主题发布者租户id
bizCode	java.lang.String	否		bizCode
subjectKeyword	java.lang.String	否		主题关键词，搜索使用,V1.1.0之后支持

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	Integer		数量
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

根据id查询点赞基本信息中文名： 根据id查询点赞
接口名： /bip/like/get
所在目录： 评论
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
id	Long	是		id

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	List<LikeInfo>		参见补充说明 LikeInfo
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息

根据条件删除点赞基本信息中文名： 根据条件删除点赞
接口名： /bip/like/deleteByConditions
所在目录： 评论
调用方式： GET（HTTPS）
请求参数

名称	类型	是否必填	示例值	描述
subjectId	java.lang.String	否		主题id
likeAccountId	Long	否		发送者id
likeAccountTenantId	Long	否		发送者租户id
subjectAccountId	Long	否		主题发布者id
subjectAccountTenantId	Long	否		主题发布者租户id
bizCode	java.lang.String	否		bizCode
id	Long	否		主键id,此条件会忽略其他条件

返回参数

名称	类型	示例值	描述
success	boolean		成功 true 失败 false
content	boolean		成功 true 失败 false
errorLevel	java.lang.String		错误级别
errorCode	java.lang.String		异常码
errorMsg	java.lang.String		异常信息