明道企业授权开放接口文档

明道企业授权开放接口文档


获取流程待办列表

<p><strong>简要描述:</strong> </p> <ul> <li>获取指定用户流程代办列表</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>{Host}/workflow/v1/instance/getTodoList</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST (application/json)</li> </ul> <p><strong>请求示例Url参数</strong></p> <pre><code>{Host}/workflow/v1/instance/getTodoList?accountId=449abe0c-e014-4836-8b60-d868cxxxxc&amp;amp;appKey=ak&amp;amp;sign=x&amp;amp;timestamp=1618837301125</code></pre> <p><strong>Params参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">accountId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>用户id,表示获取该用户的代办列表</td> </tr> <tr> <td style="text-align: left;">appKey</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>appKey</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>sign</td> </tr> <tr> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>时间戳</td> </tr> </tbody> </table> <p><strong>Body参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>0:我发起的&lt;br/&gt;3:待填写&lt;br/&gt;4:待审批&lt;br/&gt;5:待查看</td> </tr> <tr> <td style="text-align: left;">pageIndex</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>页码</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>每页数量</td> </tr> </tbody> </table> <p><strong>提交数据示例</strong></p> <pre><code>{ &amp;quot;pageIndex&amp;quot;: 1, &amp;quot;pageSize&amp;quot;: 30, &amp;quot;type&amp;quot;: 4 } </code></pre> <p><strong>返回数据说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">string</td> <td>标题</td> </tr> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td>流程实例id</td> </tr> <tr> <td style="text-align: left;">workId</td> <td style="text-align: left;">string</td> <td>工作id</td> </tr> <tr> <td style="text-align: left;">app</td> <td style="text-align: left;">object</td> <td>审批应用</td> </tr> <tr> <td style="text-align: left;">process</td> <td style="text-align: left;">object</td> <td>流程</td> </tr> <tr> <td style="text-align: left;">flowNode</td> <td style="text-align: left;">object</td> <td>当前节点</td> </tr> <tr> <td style="text-align: left;">flowNode.batchType</td> <td style="text-align: left;">int</td> <td>-2:审批意见必填(默认)&lt;br/&gt;-1:审批表单内容有必填项&lt;br/&gt; 0:允许批量审批 &lt;br/&gt; 1:需要签名</td> </tr> <tr> <td style="text-align: left;">flowNodeType</td> <td style="text-align: left;">integer(int32)</td> <td>流程角色类型 3填写4审批5通知</td> </tr> <tr> <td style="text-align: left;">instanceLog</td> <td style="text-align: left;">array</td> <td>流程实例日志</td> </tr> </tbody> </table> <p><strong>App 实体</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">string</td> <td>审批应用Id</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td>应用名称</td> </tr> <tr> <td style="text-align: left;">iconUrl</td> <td style="text-align: left;">string</td> <td>图标地址</td> </tr> <tr> <td style="text-align: left;">iconColor</td> <td style="text-align: left;">string</td> <td>图标颜色</td> </tr> </tbody> </table> <p><strong>process 实体</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">count</td> <td style="text-align: left;">integer(int64)</td> <td>流程待处理数</td> </tr> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td>审批唯一 id</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td>流程名</td> </tr> <tr> <td style="text-align: left;">parentId</td> <td style="text-align: left;">string</td> <td>编辑版id</td> </tr> </tbody> </table> <p><strong>flowNode 实体</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">actionId</td> <td style="text-align: left;">string</td> <td>流程待处理数</td> </tr> <tr> <td style="text-align: left;">alias</td> <td style="text-align: left;">string</td> <td>别名</td> </tr> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">string</td> <td>引用对象ID</td> </tr> <tr> <td style="text-align: left;">appType</td> <td style="text-align: left;">string</td> <td>应用类型 0:默认第3方,1:工作表,2:任务</td> </tr> <tr> <td style="text-align: left;">auth</td> <td style="text-align: left;">UserAuth</td> <td>审批节点需要的认证</td> </tr> <tr> <td style="text-align: left;">batch</td> <td style="text-align: left;">boolean</td> <td>是否勾选批量审批</td> </tr> <tr> <td style="text-align: left;">batchType</td> <td style="text-align: left;">integer(int32)</td> <td>批量通过 默认是-2:审批意见必填 -1:审批表单内容有必填项,0:允许 1:签名</td> </tr> <tr> <td style="text-align: left;">btnMap</td> <td style="text-align: left;">object</td> <td>自定义按钮名称</td> </tr> <tr> <td style="text-align: left;">callBackType</td> <td style="text-align: left;">integer(int32)</td> <td>-1: 无配置 0:重新执行 1:直接返回审批节点</td> </tr> <tr> <td style="text-align: left;">child</td> <td style="text-align: left;">boolean</td> <td>是否是子流程</td> </tr> <tr> <td style="text-align: left;">desc</td> <td style="text-align: left;">string</td> <td>节点说明</td> </tr> <tr> <td style="text-align: left;">encrypt</td> <td style="text-align: left;">boolean</td> <td>登录密码验证</td> </tr> <tr> <td style="text-align: left;">fieldRequired</td> <td style="text-align: left;">boolean</td> <td>字段必填</td> </tr> <tr> <td style="text-align: left;">formProperties</td> <td style="text-align: left;">array</td> <td>表单属性</td> </tr> <tr> <td style="text-align: left;">formulaMap</td> <td style="text-align: left;">object</td> <td>文本拼接字段对应的控件名称和节点名称map</td> </tr> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td>节点id</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td>节点名称</td> </tr> <tr> <td style="text-align: left;"> overruleBatchType</td> <td style="text-align: left;">integer(int32)</td> <td>批量否决 默认是-2:审批意见必填 -1:审批表单内容有必填项,0:允许 1:签名</td> </tr> <tr> <td style="text-align: left;"> passBatchType</td> <td style="text-align: left;">integer(int32)</td> <td>批量通过 默认是-2:审批意见必填 -1:审批表单内容有必填项,0:允许 1:签名</td> </tr> <tr> <td style="text-align: left;">selectNodeId</td> <td style="text-align: left;">string</td> <td>选中的节点ID</td> </tr> <tr> <td style="text-align: left;">selectNodeObj</td> <td style="text-align: left;">object</td> <td>默认选中的当前流程中的对象</td> </tr> <tr> <td style="text-align: left;">subProcessId</td> <td style="text-align: left;">string</td> <td>执行子流程id</td> </tr> <tr> <td style="text-align: left;">triggerField</td> <td style="text-align: left;">string</td> <td>触发 指定控件</td> </tr> <tr> <td style="text-align: left;">triggerFields</td> <td style="text-align: left;">string</td> <td>触发 指定控件</td> </tr> <tr> <td style="text-align: left;">triggerId</td> <td style="text-align: left;">string</td> <td>触发方式 用于发起节点 1新增 2修改</td> </tr> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">string</td> <td>类型 0发起节点 1网关 2分支 3填写 4审批 5通知 6动作 7:查找 8:webhook,9:公式,10:短信,11:邮件,12:延时,13:获取批量数据,14:代码块</td> </tr> </tbody> </table> <p><strong>auth 实体</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">overruleTypeList</td> <td style="text-align: left;">array</td> <td>审批否决需要的操作:100:审批意见 1: 签名 2:实名 3:实名+实人</td> </tr> <tr> <td style="text-align: left;">passTypeList</td> <td style="text-align: left;">array</td> <td>审批通过是需要的操作:100:审批意见 1: 签名 2:实名 3:实名+实人</td> </tr> </tbody> </table> <p><strong>formProperties 实体</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">allowAdd</td> <td style="text-align: left;">string</td> <td>1:子表允许新增</td> </tr> <tr> <td style="text-align: left;">allowCancel</td> <td style="text-align: left;">string</td> <td>1:子表允许删除</td> </tr> <tr> <td style="text-align: left;">allowEdit</td> <td style="text-align: left;">string</td> <td>1:子表允许编辑</td> </tr> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td>字段ID</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td>字段名称</td> </tr> <tr> <td style="text-align: left;">property</td> <td style="text-align: left;">string</td> <td>字段属性 1只读 2编辑 3必填 4隐藏</td> </tr> <tr> <td style="text-align: left;">showCard</td> <td style="text-align: left;">string</td> <td>是否显示在待处理卡片上</td> </tr> <tr> <td style="text-align: left;">showType</td> <td style="text-align: left;">string</td> <td>关联字段用到的</td> </tr> <tr> <td style="text-align: left;">subFormProperties</td> <td style="text-align: left;">array</td> <td>子表的字段配置</td> </tr> <tr> <td style="text-align: left;">workflow</td> <td style="text-align: left;">string</td> <td>子表权限是否使用工作流配置的</td> </tr> </tbody> </table> <p><strong> selectNodeObj 实体</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">actionId</td> <td style="text-align: left;">string</td> <td>方式:查找节点:1: 搜索,2:关联他表字段</td> </tr> <tr> <td style="text-align: left;"> appId</td> <td style="text-align: left;">string</td> <td>引用对象ID</td> </tr> <tr> <td style="text-align: left;">appName</td> <td style="text-align: left;">string</td> <td>引用对象名称</td> </tr> <tr> <td style="text-align: left;">appType</td> <td style="text-align: left;">integer(int32)</td> <td>应用类型</td> </tr> <tr> <td style="text-align: left;">appTypeName</td> <td style="text-align: left;">string</td> <td>应用名称</td> </tr> <tr> <td style="text-align: left;">countersign</td> <td style="text-align: left;">boolean</td> <td>是否是会签组</td> </tr> <tr> <td style="text-align: left;">nodeId</td> <td style="text-align: left;">string</td> <td>节点ID</td> </tr> <tr> <td style="text-align: left;">nodeName</td> <td style="text-align: left;">string</td> <td>节点名称</td> </tr> <tr> <td style="text-align: left;">nodeTypeId</td> <td style="text-align: left;">string</td> <td>类型 0发起节点 1网关 2分支 3填写 4审批 5通知 6动作 7:查找 8:webhook,9:公式,10:短信,11:邮件,12:延时,13:获取批量数据,14:代码块</td> </tr> </tbody> </table> <p><strong> instanceLog 实体</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cause</td> <td style="text-align: left;">string</td> <td>原因 20001动作节点执行失败 40001审批被否决 40002未通过分支 40003审批人无效 40004填写人无效 40005数据丢失 40007被发起人撤回</td> </tr> <tr> <td style="text-align: left;">causeMsg</td> <td style="text-align: left;">string</td> <td>原因</td> </tr> <tr> <td style="text-align: left;">createBy</td> <td style="text-align: left;">string</td> <td>操作人</td> </tr> <tr> <td style="text-align: left;">createDate</td> <td style="text-align: left;">string</td> <td>操作时间</td> </tr> <tr> <td style="text-align: left;">flowNodeId</td> <td style="text-align: left;">string</td> <td>重试的节点Id</td> </tr> <tr> <td style="text-align: left;">nodeId</td> <td style="text-align: left;">string</td> <td>节点id</td> </tr> <tr> <td style="text-align: left;">nodeName</td> <td style="text-align: left;">string</td> <td>节点名称</td> </tr> <tr> <td style="text-align: left;">nodeType</td> <td style="text-align: left;">integer(int32)</td> <td>自节点类型</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">integer(int32)</td> <td>状态 1等待,2通过,3中止,4失败,5否决,6过滤</td> </tr> </tbody> </table> <p><strong>成功</strong></p> <pre><code>{ &amp;quot;data&amp;quot;: [ { &amp;quot;app&amp;quot;: { &amp;quot;describe&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;icon&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;iconColor&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;iconUrl&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;id&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;&amp;quot; }, &amp;quot;completeDate&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;createAccount&amp;quot;: { &amp;quot;accountId&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;avatar&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;fullName&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;isOwner&amp;quot;: true, &amp;quot;status&amp;quot;: 0 }, &amp;quot;createDate&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;entityName&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;flowNode&amp;quot;: { &amp;quot;appType&amp;quot;: 0, &amp;quot;batchType&amp;quot;: 0, &amp;quot;desc&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;id&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;overruleBatchType&amp;quot;: 0, &amp;quot;passBatchType&amp;quot;: 0 }, &amp;quot;flowNodeType&amp;quot;: 0, &amp;quot;id&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;process&amp;quot;: { &amp;quot;count&amp;quot;: 0, &amp;quot;id&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;parentId&amp;quot;: &amp;quot;&amp;quot; }, &amp;quot;status&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;title&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;workId&amp;quot;: &amp;quot;&amp;quot; } ], &amp;quot;msg&amp;quot;: &amp;quot;成功&amp;quot;, &amp;quot;status&amp;quot;: 1 } </code></pre>

页面列表

ITEM_HTML