电子表单REST服务接口使用说明
使用电子表单CRUD的服务接口,必须先获得接口访问权限标识,即得到有效的token,然后在请求接口时,把token的值传递给http header即可,具体参考以下接口使用说明。
接口地址: http://127.0.0.1:30001/api/system/robotLogin
请求类型: POST
内容类型: application/json;charset=UTF-8
请求数据:
{
“username”: “admin”,
“password”: “admin”
}
用户名和密码根据实际情况填写
返回数据:
{
“success”: true,
“message”: “操作成功!”,
“code”: 200,
“result”: {
“userInfo”: {
“id”: “e9ca23d68d884d4ebb19d07889727dae”,
“createBy”: “admin”,
“createTime”: “2020-01-01 00:00:00”,
“updateBy”: null,
“updateTime”: “2020-08-12 16:21:34”,
“sysOrgCode”: “A01A01”,
“username”: “admin”,
“realname”: “管理员”,
“userNum”: null,
“userSecret”: null,
“userOrder”: 1,
“isRealUser”: “1”,
“userWeixin”: null,
“userQq”: null,
“userExt1”: null,
“userExt2”: null,
“userExt3”: null,
“userExt4”: null,
“userExt5”: null,
“userExt6”: null,
“avatar”: null,
“birthday”: “2020-01-01”,
“sex”: 1,
“email”: null,
“phone”: null,
“orgCode”: “A01A01”,
“orgId”: “b1277d6810ff4fa3afa19b39162a43a9”,
“orgName”: “研发中心”,
“backRoleFlg”: “1”,
“status”: 1,
“delFlag”: 0,
“workNo”: “001”,
“post”: null,
“telephone”: null,
“activitiSync”: 1,
“userIdentity”: null,
“departIds”: null,
“thirdId”: null,
“thirdType”: null
},
“token”: “eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MDE4Njg5MjAsInVzZXJuYW1lIjoiYWRtaW4ifQ.LfwtqcGB8I7qN2DcpDN_xyoN11CJke7biIYb4POuWk8”
},
“timestamp”: 1601856787111
}
注意:返回的数据中,token是后续接口操作的凭证,该token的有效期是24小时,如果在24小时内有接口请求操作,那么该token将一直不过期,请求服务接口时,把token值放到请求Header里即可,KEY标识为X-Access-Token。
接口地址:
http://127.0.0.1:30001/api/eform/engine/formEngine/saveData?formKey=demoUserInfoForm&isFlow=false
参数说明:
formKey:为电子表单模型的表单标识
isFlow:是否带流程标识
请求类型: POST
内容类型: application/json;charset=UTF-8
接口访问标识:
X-Access-Token: xxxxxxxxxxxxxxxxxxxxx
使用第1步动态获取token,赋值给X-Access-Token
请求数据:
{
“formData”: {
“demoUserInfoObj”: {
“userTel”: “13810500956”,
“userName”: “张三”,
“userAge”: 25,
“registerDate”: “2020-10-05 12:03:00”
}
}
}
参数说明:
demoUserInfoObj:为该电子表单使用的ER模型标识,请到后台查看ER模型获取该值;
返回数据:
{
“success”: true,
“message”: “保存成功!”,
“code”: 200,
“result”: “1312954707102384129”,
“timestamp”: 1601867770385
}
以下是postman测试截图:
接口地址:
http://127.0.0.1:30001/api/eform/engine/formEngine/saveData?formKey=demoUserInfoForm&isFlow=false
参数说明:
formKey:为电子表单模型的表单标识
isFlow:是否带流程标识
请求类型: POST
内容类型: application/json;charset=UTF-8
接口访问标识:
X-Access-Token: xxxxxxxxxxxxxxxxxxxxx
使用第1步动态获取token,赋值给X-Access-Token
请求数据(必须有id,使用方式同保存数据接口):
{
“formData”: {
“demoUserInfoObj”: {
“userTel”: “13810500956”,
“id”: “1312966536734162946”,
“userName”: “张三”,
“userAge”: 26,
“registerDate”: “2020-10-05 12:03:00”
}
}
}
接口地址:
参数说明:
formKey:为电子表单模型的表单标识
id:为该条业务数据的主键id
请求类型: GET
内容类型: application/json;charset=UTF-8
接口访问标识:
X-Access-Token: xxxxxxxxxxxxxxxxxxxxx
使用第1步动态获取token,赋值给X-Access-Token
返回数据:
{
“success”: true,
“message”: “操作成功!”,
“code”: 200,
“result”: {
“dictModelMap”: {},
“elValue”: {},
“html”: “”,
“initData”: {},
“data”: {
“demoUserInfoObj”: {
“createBy”: “e9ca23d68d884d4ebb19d07889727dae”,
“createTime”: “2020-10-05 12:03:11”,
“updateBy”: “e9ca23d68d884d4ebb19d07889727dae”,
“sysOrgCode”: “b1277d6810ff4fa3afa19b39162a43a9”,
“userTel”: “13810500956”,
“updateTime”: “2020-10-05 12:06:41”,
“id”: “1312966536734162946”,
“userName”: “张三”,
“userAge”: 26,
“registerDate”: “2020-10-05 12:03:00”
}
}
},
“timestamp”: 1601870947512
}
其中:data 里的数据是该条业务表单数据
接口地址:
参数说明:
ids:为业务数据id
boCode:为电子表单模型使用的ER模型标识
isFlow:是否带流程标识
请求类型: DELETE
内容类型: application/json;charset=UTF-8
接口访问标识:
X-Access-Token: xxxxxxxxxxxxxxxxxxxxx
使用第1步动态获取token,赋值给X-Access-Token
返回数据:
{
“success”: true,
“message”: “删除成功”,
“code”: 200,
“result”: null,
“timestamp”: 1601870227068
}
接口地址:
http://127.0.0.1:30001/api/eform/engine/viewEngine/queryViewList?viewCode=demo
参数说明:
viewCode:为列表页面模型的标识
请求类型: POST
内容类型: application/json;charset=UTF-8
接口访问标识:
X-Access-Token: xxxxxxxxxxxxxxxxxxxxx
使用第1步动态获取token,赋值给X-Access-Token