OpenAPI使用指南

使用教程

创建应用

请创建并发布对应的应用，详情可参考「用户手册」>>「应用管理」>>「创建应用」。

授权API接口调用权限

通过入口：开发平台>>系统管理>>集成中心>>API管理，授权OpenAPI接口权限。

了解基础参数概念及获取方式

corpId/secret/account参数说明：

参数	数据类型	说明
corpId	string	企业Id
secret	string	租户密钥
account	string	管理员账号

corpId/secret/account获取方式：

applicationId参数说明：

参数	数据类型	说明
applicationId	string	应用id

applicationId获取方式：

formModelId参数说明：

参数	数据类型	说明
formModelId	string	表单模型Id

formModelId获取方式：

modelId参数说明：

参数	数据类型	说明
modelId	string	流程模型Id

modelId获取方式：

通过AccessKey获取Token

说明:1.获取AccessKey

    2.通过AccessKey获取Token

获取AccessKey

请求说明

请求方式：GET 请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/securities/access_key?timestamp={timestamp}&random={random}&corpId={corpId}&secret={secret}&account={account} (opens new window)

请求参数

参数	必须	数据类型	说明
timestamp	是	string	时间戳
random	是	string	随机数
corpId	是	string	企业Id
secret	是	string	租户密钥
account	是	string	管理员账号

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": "ed89a315a5b3289be9c8b95c3052664c"
}

返回参数说明

参数	数据类型	说明
data	String	用于获取Token的AccessKey

获取Token

注意事项

两次请求的timestamp与random需保持一致

请求说明

请求方式：GET 请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/securities/qiqiao_token?timestamp={timestamp}&random={random}&corpId={corpId}&secret={secret}&account={account}&accessKey={accessKey} (opens new window)

请求参数

参数	必须	数据类型	说明
timestamp	是	string	时间戳
random	是	string	随机数
corpId	是	string	企业Id
secret	是	string	租户密钥
account	是	string	管理员账号
accessKey	是	string	密钥

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": "qiqiaoToken"
}

返回参数说明

参数	数据类型	说明
data	String	携带Token用于访问Api

限制说明

调用频率限制：每个接口一分钟内仅限调用三次（注意：仅获取AccessKey与Token有此限制） Token有效时长限制：8小时

调用OpenAPI接口示例

全局错误码

6400001=超出请求频率限制
6400002=accessToken过期
6400003=没有接口请求权限
6400004=接口参数缺失
6400005=找不到用户Id为{0}的用户
6400006=企业信息错误
6400007=API未授权
6400008=当前页数小于0
6400009=每页显示数小于1
6400011=不存在用户account为{0}的用户
6400012=account不可为空
6400013=loginUserId不可为空
6400014=Token失效
6400015=无效参数【loginUserId】
6400016=密钥不能为空
6400017=密钥错误或者过期

5400001=流程定义Id:{0}错误，无法匹配到流程定义实例
5400002=流程定义Key:{0}错误，无法匹配到流程定义实例
5400003=流程定义Id或key参数不能为空
5400004=流程任务:{0}没有配置参与者路由
5400005=目前仅支持中国式流程,请在开始事件后接人工任务
5400006=流程定义配置异常
5400007=解析流程定义异常
5400008=bpmn2.0 xml文件读取过程发生错误
5400009=流程模型Id:{0}错误，无法匹配到流程定义实例,请重新配置
5400010=子流程不存在
5400011=流程实例Id:{0}错误，无法匹配到流程实例
5400012=节点名称:{0}获取可执行性连线失败,导致无法正确获取下一节点流
5400013=流程连线配置条件组判断，存在条件组配置的关联表单字段值为空，故不允许流转
5400014=找不到处理人
5400015=系统任务:{0}执行异常
5400016=不能加签给当前处理人
5400017=不能加签给下一步处理人
5400018=任务实例ID不能为空,无法确认处理人身份
5400019=办理失败，不符合流转条件
5400020=回退节点不能为空
5400021=不能委托给当前处理人
5400022=不能传阅给自己
5400023=被传阅人不能为空
5400024=被委托人不能为空
5400025=数据已被其他用户修改，请刷新后重试
5400026=当前用户不是该节点的当前处理人，请刷新后重试
5400027=不能委托给自己
5400028=不能加签给自己
5400029=数据已被其他用户修改，请刷新后重试
5400030=当前流程实例不是运行状态
5400031=当前流程实例处于撤销状态
5400032=当前处理人不是流程发起人
5400033=无法获取下一节点（子流程）处理人，请联系管理员
5400034=该流程不允许单步回收，请刷新后重试
5400035=您无权限对该流程进行单步回收，请刷新后重试
5400036=流转规则设置有误，请联系管理员
5400037=当前节点不允许撤销
5400038=同一任务节点下不允许有相同处理人
5400039=被委托的流程不能设定为空，请重新定义
5400040=委托规则不存在，请刷新后重试
5400041=同一时间段同一流程只能设置一条规则，请调整
5400042=当前委托规则生效中，不允许修改委托规则
5400043=请选择办理人
5400044=处理人不允许为空
5400045=委托规则的开始时间不能晚于结束时间，请重新定义
5400046=当前流程节点需添加手写签名，请重新定义
5400047=当前流程标题已超过限制（上限200），请调整后再提交
5400048=驳回节点和当前节点存在网关、子流程，提交时必须重新流转，请选择【重新流转】
5400049=当前流程标题已超过限制（上限200），请调整后再提交
5400050=该流程已被删除，暂时无法查看
5400051=您暂无该流程查看权限
5400052={0}节点,{1}正在审批中,请勿调整
5400999={0}

1200001=获取通讯录部门Id:{0}的相关数据失败
1200002=获取通讯录用户Id:{0}的相关数据失败
1200003=获取通讯录指定部门Id:{0}用户数据失败
1200004=获取通讯录用户组Id:{0}相关数据失败
1200005=用户Accout为:{0}的数据,UserId缺失
1200006=用户Id为:{0}的数据,Account缺失
1200007=批量获取Ids:{0}通讯录岗位类别相关数据失败
1200008=根据岗位类别Id:{0}获取岗位相关数据失败
1200009=批量获取Ids:{0}通讯录岗位相关数据失败
1200010=根据组织ids:{0}、岗位ids:{1}获取人员列表相关数据失败
1200011=获取用户头像失败
1200012=获取部门ID为:{0}的上级部门失败

1300001=获取脚本引擎失败，应用ID为空
1300002=低代码模型已告警，不允许执行
1300003=自定义页面代码执行异常，请联系管理员
1300004={0}

5500001=表单模型解析错误
5500002=表单已被修改，请更新数据再操作
5500003=表单对象form不能为空
5500004=创建表单布局控件{0}失败
5500005=创建表单控件{0}失败
5500006=表单行为对象构建失败，缺少必须参数
5500007=表结构解析错误
5500008=控件Id:{0}错误，无法匹配到相应控件
5500009=控件Id:{0}匹配错误，实际类型与目标类型不匹配
5500010=文件{0}失败
5500011=子表数据格式不正确
5500012={0}长度超出，请联系管理员
5500013=表单{0}配置错误，外键至少有一个已选字段，请检查表单配置
5500014=ID={0}的控件不是一个合法的多对多表单控件
5500015=表单Id:{0}错误，无法匹配到相应表单
5500016=子表中外键配置有误，主表id:{0}，子表中外键关联表单id:{1}
5500017=表单引擎运行时出现错误
5500018=保存表单数据失败
5500019=删除表单数据失败
5500020=查询表单数据失败
5500021=表单[{0}]下[{1}]配置的原控件可能已被删除，请至开发平台检查配置
5500022=控件[{0}]必须为[{1}]控件，请至开发平台检查配置
5500023=表单id不能为空
5500024={0}已分配完，无法提交新数据；请联系管理员
5500025={0}
5500030=表单组件[{0}]配置有误，请检查配置
5500031=表单不存在
5500032=[{0}]的关联字段被删除，请联系管理员
5500033=绑定表单中的子表单配置有误，请联系管理员
5500034=绑定表单中的子表关联配置有误，请联系管理员
5500035=绑定表单中的多表关联配置有误，请联系管理员
5500036=绑定表单中的外键配置有误，请联系管理员
5500037=获取文件预览链接错误,id:{0}
5500046=找不到字段名为[{0}]的排序字段
5500038=表单字段[{0}]不存在，请检查表单
5500039=创建表单日志索引错误
5500050=表单实例不存在
5500051=汇总组件字段公式配置有误，请联系管理员
5500052=文件大小不合法,最大不能超过20M
5400053=请指定{0}节点处理人
5400054=流程模型Id:{0},流程版本：{1}错误，无法匹配到流程定义实例,请重新配置
5400055=当前流程实例ID:{0},节点任务ID：{1}，请保证同时赋值或同为空值
5400056=请传入指定节点
5400060=参数loginUserId:{0}不正确,未匹配到指定用户
5400061=根据流程模型id：{0}，流程实例id：{1}，未配置到指定流程定义
5400062=指定节点activityDefinitionId必传
5400063=指定节点activityName必传
5400064=指定节点activityType必传
5400065=指定节点designateName必传

5900037=条件表达式编译失败，请检查配置
5900038=条件表达式字段格式不正确，请联系管理员
5900039=条件表达式字段格式不正确，请联系管理员
5900040=条件表达式配置中有字段不存在，请检查配置
5900041=条件表达式编译失败，请检查配置
5900042=条件表达式函数{0}参数数量错误，请检查配置
5900043=条件表达式函数{0}含非法字段，请检查配置
5900044=表达式用户信息格式不正确，请检查配置
5900045=表达式用户信息字段不存在，请检查配置
5900046=汇总字段公式中存在访问不到的字段{0}，请检查配置

6100001=表达式解析标题内容失败，请检查配置是否正确
6100002=表达式执行失败，请检查配置是否正确
6100003=表达式解析失败，请检查配置是否正确

6200001=触发事件公式编译失败，请检查配置是否正确
6200002=触发通知事件失败，暂不支持自定义时间通知
6200003=触发通知事件失败，接收人脚本设置有误