错误码
错误编码 | 错误信息 | 解决方案 |
---|---|---|
9000 | appId错误 | |
9001 | timestamp错误 | |
9002 | nonce错误 | |
9003 | 签名错误 | |
100 | 用户名不能为空 | |
101 | 用户名不存在 | |
200 | flowId错误 | |
201 | 流程不存在 |
接口请求地址说明 公共参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
appId | String | 必填 | OA系统分配给应用的唯一标识 |
timestamp | String | 必填 | 请求时间戳,格式:yyyyMMddHHmmssSSS.要求每次请求时重新生成,与服务器时间上下超过5分钟,请求将被拒绝 |
sign | String | 必填 | 数字签名 |
nonce | String | 必填 | 32位由数字+大写字母组成的随机字符串,每次请求必须重新生成 |
数字签名的生成方法
将公共参数中除sign外的参数,按照字母顺序排序后用&符号拼接,再拼上业务参数,组成待签名串,例如: appId=oa2erp2021&nonce=1234567890×tamp=20170802094500123 其中公共参数:appId,nonce,timestamp。
数字签名的加密算法
数字签名使用RSA算法和私钥生成加密串,采用公共参数拼接业务参数进行混淆,最后生成签名串。 如:使用上面的签名内容和下面的私钥
发起工作流接口
流程的字段名称,例如data_m1、data_m2,字段描述可以通过调用流程字段接口获取
基本信息
- 接口状态: 已完成
- 接口URL:
{{host}}/api/workflow/
- 请求方式:
POST
- Content-Type:
multipart/form-data
请求参数
接口请求参数见下表:
Query参数说明
参数名 |
示例值 |
是否必填 |
参数类型 |
参数描述 |
---|
Header参数说明
参数名 |
示例值 |
是否必填 |
参数类型 |
参数描述 |
---|---|---|---|---|
appId |
oa2erp2021 |
必填 |
- |
|
timestamp |
123 |
必填 |
- |
|
nonce |
567 |
必填 |
- |
|
sign |
gUyNG8z00ljRrSxiT4BnqmsMDZM3BJMnaP9QMumkP4dBdWOnZDSCRw6p+imwSz97bEApMrcSm3Eh9r1Fu7mJ6KoFL2L1SNtbpkQ3XwBY7evlCW85UdZgYQGGx2b4HsUsD9TfzwqrJ9QDcPOWmzZhYARAaHQUQaY5lW7Xu+UlM3w= |
必填 |
- |
|
Body参数说明 (multipart/form-data)
参数名 |
示例值 |
是否必填 |
参数类型 |
参数描述 |
---|---|---|---|---|
flowId |
1 |
必填 |
- |
|
uname |
zhangsan |
必填 |
- |
|
data_m1 |
会议名称XXX |
必填 |
- |
|
data_m3 |
会议地点XXX |
必填 |
- |
|
响应示例
正确响应示例
{
"code": 0,
"runid": 20,
"msg": "OK"
}
错误响应示例
获取流程字段接口
错误编码 | 错误信息 | 解决方案 |
---|---|---|
9000 | appId错误 | |
9001 | timestamp错误 | |
9002 | nonce错误 | |
9003 | 签名错误 | |
100 | 用户名不能为空 | |
101 | 用户名不存在 | |
200 | flowId错误 | |
201 | 流程不存在 |
基本信息
- 接口状态: 已完成
- 接口URL:
{{host}}/api/workflow/doc.php
- 请求方式:
POST
- Content-Type:
multipart/form-data
请求参数
接口请求参数见下表:
Query参数说明
参数名 |
示例值 |
是否必填 |
参数类型 |
参数描述 |
---|
Header参数说明
参数名 |
示例值 |
是否必填 |
参数类型 |
参数描述 |
---|
Body参数说明 (multipart/form-data)
参数名 |
示例值 |
是否必填 |
参数类型 |
参数描述 |
---|---|---|---|---|
flowId |
1 |
必填 |
- |
|
uname |
admin |
必填 |
- |
|
响应示例
正确响应示例
[
{
"name": "data_m1",
"desc": "会议名称",
"type": "varchar"
},
{
"name": "data_m2",
"desc": "时间",
"type": "calendar"
},
{
"name": "data_m3",
"desc": "会议地点",
"type": "varchar"
},
{
"name": "data_m4",
"desc": "主持人",
"type": "varchar"
},
{
"name": "data_m5",
"desc": "会议主题",
"type": "varchar"
},
{
"name": "data_m6",
"desc": "出席人员",
"type": "orgSelect"
},
{
"name": "data_m7",
"desc": "列席人员",
"type": "orgSelect"
},
{
"name": "data_m8",
"desc": "会议内容",
"type": "text"
},
{
"name": "data_m9",
"desc": "会议决议",
"type": "text"
},
{
"name": "data_m10",
"desc": "领导签字",
"type": "auto"
},
{
"name": "data_m11",
"desc": "记录人",
"type": "auto"
}
]
技术支持QQ 2524837118
错误响应示例
{
"code": "201",
"msg": "流程不存在"
}
{
"code": 300,
"msg": "签名错误"
}