API开放平台

TIP

# 流程表单接口

# 新增流程接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/userDefined/v1/processFlow/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "emp_code":"11111",
    "approvers": "",
	"ccs":"22222",
    "flow_id":"7599877067002364152",
    "form_data":{
        "pt":{
            "slfdf_633172":"",
            "slfdf_623593":"2020-05-12",
            "slfdf_119047":"",
            "slfdf_606207":"泰州",
            "slfdf_855810":"",
            "slfdf_820645":"",
            "slfdf_352300":"1",
            "slfdf_194010":"111",
            "slfdf_595402":"",
            "slfdf_191584":"111",
            "slfdf_340307":"",
            "slfdf_191400":"2020-05-13",
            "terminal_type":"3"
        },
        "sts":[
            {
                "id":"8317290435308000015",
                "rows":[
                    {
                        "slfdf_482477":"飞机票",
                        "slfdf_955369":"111",
                        "slfdf_730543":""
                    }
                ]
            }
        ]
    }
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
flow_id VARCHAR(32) 是 流程id
emp_code VARCHAR(100) 是 勤策系统中申请人代码
approvers VARCHAR(100) 否 下一步骤处理人（下个节点的处理人为前一步骤处理时指定时需要必填）
ccs VARCHAR(200) 否 抄送人编码，多选，多位以","分隔
form_data.pt 是 该流程主记录
form_data.sts 是 该流程明细（子表）记录
form_data.pt.slfdf_* 否 主记录数据（字段编码详见页面接口数据）
form_data.sts.id CHAR(32) 是 明细数据的表格id
form_data.sts.rows.slfdf_* 否 明细数据（字段编码详见页面接口数据）

响应示例：

{
    "msg_id": "X000001",
    "response_data": {
		"formId":"7376519253924031447",
		"approve_logs":[
			{
				"approver":"zy(职务1)  录入",
				"node_name":"开始",
				"exe_type":"1",
				"comment":null
			}
		],
		"dataId":"5937166066373570213",
		"flowId":"8621940552826810569",
		"status":"未审批"
	},
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data String 参照查询流程接口的返回结果

# 查询流程接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/userDefined/v1/getFlowConfig/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "flowId":"7599877067002364152",
    "startDate": "2020-05-12",
	"endDate":"2020-05-12",
	"handleDateStart": "2020-05-12 10:08:01",
	"handleDateEnd":"2020-05-12 15:08:01",
    "empId":"7599877067002364152",
	"page":"1",
	"rows":"100"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
flowId VARCHAR(32) 否 流程id
startDate CHAR(10) 否 上报日期起
endDate CHAR(10) 否 上报日期止
handleDateStart VARCHAR(32) 否 最后修改日期起，格式：yyyy-MM-dd HH:mm:ss
handleDateEnd VARCHAR(32) 否 最后修改日期止，格式：yyyy-MM-dd HH:mm:ss
empId VARCHAR(32) 否 申请人id
page VARCHAR(10) 否 页数
rows VARCHAR(10) 否 每页条数

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "formId":"8380014622632604678",
        "serialNo":"20200915000004",
        "dataId":"6541954866021161128",
        "flowId":"6933547335575721944",
        "status":"未审批",
        "recently_handle_time":"2020-09-22 09:40",
        "recently_handler_name":"测试账号(初始化-3)",
        "recently_handler_code":"ceshi",
		"time_consuming":"15.6",
        "approve_logs":[
                {
                    "approver":"测试账号(初始化-3)  录入",
                    "node_name":"开始",
                    "exe_type":"1",
                    "time":"2020-09-22 09:40:30",
                    "comment":""
                }
            ]
    }
]

参数说明：

参数 类型 说明
flowId VARCHAR(32) 流程流水号
serialNo VARCHAR(32) 流水号
status VARCHAR(32) 流程当前状态
formId VARCHAR(32) 相应流程的表单模板ID
dataId CHAR(10) 相应流程的表单数据ID
recently_handle_time VARCHAR(32) 最近处理时间
recently_handler_name VARCHAR(32) 最近处理人姓名
recently_handler_code VARCHAR(32) 最近处理人账号
time_consuming NUMERIC 审批历时，单位：分钟
approve_logs.approver VARCHAR(100) 账号+操作
approve_logs.node_name VARCHAR(32) 节点名称
approve_logs.exe_type CHAR(1) 操作类型。1：录入，2：批准，3：拒绝
approve_logs.time VARCHAR(32) 操作时间。格式：yyyy-MM-dd HH:mm:ss
approve_logs.comment VARCHAR(500) 评价

# 查询流程申请数据V2

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/userDefinedV2/v2/queryFlowApply/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "serialNo":"20220803000004",
    "exeId":"6148612275888903964",
    "flowId":"8916045927179990560",
    "formId":"7228037776563689845",
	"dataId":"8517961366438930194",
    "approveStatus":"1,2",
    "startDate":"2022-08-03",
    "endDate":"2022-08-04",
	"handleDateStart": "2020-05-12 10:08:01",
	"handleDateEnd":"2020-05-12 15:08:01",
    "approverIds":"4683250850618465770",
	"page":1,
    "rows":1000
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
flowId VARCHAR(32) 否 流程ID
formId VARCHAR(32) 否 流程关联表单ID
exeId VARCHAR(32) 否 流程申请数据ID
dataId VARCHAR(32) 否 申请关联数据ID
approveStatus VARCHAR(2) 否 审批状态，0：未审批，3：审批中，1：已通过，2：已打回，4：已作废，多个状态以“,”分隔拼接
serialNo VARCHAR(32) 否 流水号，精确查询
startDate VARCHAR(32) 否 申请日期起，格式：yyyy-MM-dd
endDate VARCHAR(32) 否 申请日期止，格式：yyyy-MM-dd
handleDateStart VARCHAR(32) 否 最后修改日期起，格式：yyyy-MM-dd HH:mm:ss
handleDateEnd VARCHAR(32) 否 最后修改日期止，格式：yyyy-MM-dd HH:mm:ss
approverIds VARCHAR(2000) 否 申请人ID，来源于勤策员工唯一ID，多人以“,”分隔拼接
page VARCHAR(10) 否 页数
rows VARCHAR(10) 否 每页条数

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "applierCode":"ljx",
		"applierId":"4683250850618465770",
		"applierName":"李俊兴",
		"applyTime":"2022-08-03 03:08:45",
		"approveStatus":"1",
		"dataId":"5844589824032142598",
		"exeId":"6148612275888903964",
		"flowId":"8916045927179990560",
		"formId":"7228037776563689845",
		"nextExecutorCodes":"zhangsan",
		"nextExecutorIds":"7681060226227315770",
		"nextExecutorNames":"张三",
		"proxyApplierCode":"zhangsan",
		"proxyApplierId":"7681060226227315770",
		"proxyApplierName":"zhangsan",
		"recentExecuteTime":"2022-08-03 03:08:45",
		"recentExecutorCode":"ljx",
		"recentExecutorId":"4683250850618465770",
		"recentExecutorName":"李俊兴",
		"serialNo":"20220803000004",
		"timeConsuming":15.23
    }
]

参数说明：

参数 类型 说明
flowId VARCHAR(32) 流程ID
formId VARCHAR(32) 流程关联表单ID
exeId VARCHAR(32) 流程申请数据ID
dataId VARCHAR(32) 流程申请表单数据ID
serialNo VARCHAR(32) 流水号
approveStatus VARCHAR(2) 流程当前状态，0：未审批，3：审批中，1：已通过，2：已打回，4：已作废
applyTime VARCHAR(32) 申请时间
applierId VARCHAR(32) 申请人ID，来源于勤策员工唯一ID
applierCode VARCHAR(32) 申请人账号
applierName VARCHAR(32) 申请人姓名
proxyApplierId VARCHAR(32) 代理申请人ID，来源于勤策员工唯一ID
proxyApplierCode VARCHAR(32) 代理申请人账号
proxyApplierName VARCHAR(32) 代理申请人姓名
recentExecuteTime VARCHAR(32) 最近处理时间
recentExecutorId VARCHAR(32) 最近处理人ID，来源于勤策员工唯一ID
recentExecutorCode VARCHAR(32) 最近处理人账号
recentExecutorName VARCHAR(32) 最近处理人姓名
nextExecutorIds TEXT 下一办理人ID，来源于勤策员工唯一ID
nextExecutorCodes TEXT 下一办理人账号
nextExecutorNames TEXT 下一办理人姓名
timeConsuming NUMBERIC 审批历时，单位：分钟

# 查询流程模板配置

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/userDefined/v1/getFlowSetConfig/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "flowSetId":"7599877067002364152"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
flowSetId VARCHAR(32) 是 流程模板id

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "formId":8380014622632604678,
        "flowName":"小周",
        "groupId":8380014622632604678,
        "groupName":"分组名",
        "sequence":0,
        "userdRoleName":"",
        "manageDeptName":"",
        "syncToSwap":"0",
        "repeatApproval":"0",
        "remarks":""
    }
]

参数说明：

参数 类型 说明
formId VARCHAR(32) 相应流程的表单的ID
flowName VARCHAR(200) 流程名称
groupId VARCHAR(32) 分组id
groupName VARCHAR(200) 分组名
sequence VARCHAR(32) 排序号
userdRoleName VARCHAR(200) 适用范围
manageDeptName VARCHAR(200) 管理范围
syncToSwap VARCHAR(32) 是否启用同步接口
repeatApproval VARCHAR(32) 重复策略是否勾选
remarks VARCHAR(200) 备注

# 查询流程模板配置V2

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/userDefinedV2/v2/queryFlowSetting/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"flowIds":"7899478435245646130",
    "page":1,
    "rows":1000
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
flowIds VARCHAR(2000) 是 流程ID，多个以“,”分隔拼接
page VARCHAR(10) 否 页数
rows VARCHAR(10) 否 每页条数

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "flowId": "7899478435245646130", 
        "flowName": "705表单优化", 
        "flowStatus": "1", 
        "forbidBatchApprove": "0", 
        "formId": "8609193539843128376", 
        "formName": "705表单优化", 
        "groupId": "5533948904965466972", 
        "groupName": "分组", 
		"assignType": "2",
		"assignEmps": "4683250850618465770,5515186636663395049",
		"assignDepts": "8276406587750760638",
		"assignPositions": "8626895656893956925",
		"assignRoles": "5867309398741087467",
        "manageRange": "7004488254883301280,8569534112355815529", 
        "overTimeRemind": "0", 
        "recentModifierCode": "lisi", 
        "recentModifierId": "6668658433846171600", 
        "recentModifierName": "李四", 
        "recentModifyTime": "2022-08-06 08:53:53.248", 
        "remark": "备注111", 
        "repeatApprova": "0", 
        "resubmitOrigin": "0", 
        "sync": "0", 
        "timingRemind": "0", 
        "used": "0"
    }
]

参数说明：

参数 类型 说明
flowId VARCHAR(32) 流程ID
flowName VARCHAR(200) 流程名称
formId VARCHAR(32) 流程关联表单ID
formName VARCHAR(200) 流程关联表单名称
groupId VARCHAR(32) 分组ID
groupName VARCHAR(200) 分组名称
assignType CHAR(1) 使用范围，1：全部人员，6：指定范围
assignEmps TEXT 使用范围，指定人员，人员ID来源于勤策员工唯一ID
assignDepts TEXT 使用范围，指定部门，部门ID来源于勤策部门唯一ID
assignPositions TEXT 使用范围，指定职务，职务ID来源于勤策职务唯一ID
assignRoles TEXT 使用范围，指定角色，角色ID来源于勤策角色唯一ID
manageRange TEXT 管理范围，管理范围中的部门ID来源于勤策部门唯一ID
sync CHAR(1) 是否启用同步接口，1：是，0：否
remark VARCHAR(2000) 备注
repeatApprova CHAR(1) 重复审批策略，空：未开启，1：相邻审批节点为同一审批人时仅需审批一次，2：同一流程内的同一审批人仅需审批一次
forbidBatchApprove CHAR(1) 是否禁止批量审批，1：是，0：否
resubmitOrigin CHAR(1) 被打回节点再次提交时是否直接回到打回节点，1：是，0：否
timingRemind CHAR(1) 是否开启定时提醒，1：是，0：否
overTimeRemind CHAR(1) 是否开启超时提醒，1：是，0：否
used CHAR(1) 是否使用，1：是，0：否
flowStatus CHAR(1)) 流程状态，0：未启用，1：已启用，2：已停用
recentModifyTime VARCHAR(32) 最后修改时间
recentModifierId VARCHAR(32) 最后修改人ID，来源于勤策员工唯一ID
recentModifierCode VARCHAR(200) 最后修改人账号
recentModifierName VARCHAR(200) 最后修改人姓名

# 查询流程申请审批历程

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/userDefined/v1/queryFlowApplyLog/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"exeId":6148612275888903964,
    "serialNo":"20220803000004",
    "page":1,
    "rows":1000
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
exeId VARCHAR(32) 是 流程申请数据ID
serialNo VARCHAR(32) 是 流水号，精确查询
page VARCHAR(10) 否 页数
rows VARCHAR(10) 否 每页条数

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "approverCode": "ljx", 
        "approverId": "4683250850618465770", 
        "approverName": "李俊兴", 
        "exeId": "6148612275888903964", 
        "exeType": "2", 
        "nodeId": "6201574080752690869", 
        "nodeName": "审批", 
        "operateTime": "2022-08-03 04:08:27", 
        "opinion": "意见", 
        "serialNo": "20220803000004"
    }
]

参数说明：

参数 类型 说明
exeId VARCHAR(32) 流程申请数据ID
serialNo VARCHAR(200) 流水号
nodeId VARCHAR(32) 审批节点ID
nodeName VARCHAR(200) 审批节点名称
approverId VARCHAR(32) 节点审批人ID，来源于勤策员工唯一ID
approverCode VARCHAR(200) 节点审批人账号
approverName VARCHAR(200) 节点审批人姓名
exeType CHAR(1) 节点审批操作，1：录入，2：批准，3：打回
operateTime VARCHAR(32) 节点操作时间，格式：yyyy-MM-dd HH:mm:ss
opinion VARCHAR(200) 审批意见

← 流程表单数据推送 →