广汽二期--公共模块对外接口
<p>[TOC]</p>
<h1>广新二期 公共模块接口文档</h1>
<table>
<thead>
<tr>
<th>版本</th>
<th>时间</th>
<th>修改人</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td>V2.1</td>
<td>2022813</td>
<td>谢凤胜</td>
<td>修改获取用户信息接口</td>
</tr>
<tr>
<td>V2.2</td>
<td>2022824</td>
<td>谢凤胜</td>
<td>更新测试环境地址</td>
</tr>
</tbody>
</table>
<h1>广汽应用系统对接前置说明</h1>
<ol>
<li>广新二期项目登录修改为 <strong>公共模块对接广汽的IAM SSO</strong>，之前有接入公共模块登录的应用系统，注释掉之前对接的代码，只留下通过token获取用户信息接口；</li>
<li>二期角色，权限设置不变</li>
</ol>
<p>外网在线接口文档地址： <a href="https://www.showdoc.com.cn/gaccms">https://www.showdoc.com.cn/gaccms</a></p>
<h1>【腾讯文档】公共模块对接说明文档</h1>
<p><a href="https://docs.qq.com/slide/DT2pISWJKVklsVUVp">https://docs.qq.com/slide/DT2pISWJKVklsVUVp</a></p>
<p>公网开发环境：
一期：<a href="http://cms.gp2dev.fii-fmc.com/">http://cms.gp2dev.fii-fmc.com/</a>
二期：<a href="http://cms2.gp2dev.fii-fmc.com">http://cms2.gp2dev.fii-fmc.com</a>
账密: //提示修改密码的，请修改为 Gac123456!!
t202180 Gac123456!! 冲压
t202206 Gac123456!! 冲压
t202207 Gac123456!! 冲压
t202208 Gac123456!! 冲压 2厂
t202183 Gac123456!! 总装
t202184 Gac123456!! 总装
t202218 Gac123456!! 总装 2厂
t202182 Gac123456!! 涂装 2厂
t202200 Gac123456!! 涂装
t202201 Gac123456!! 涂装
t202181 Gac123456!! 焊装
t202203 Gac123456!! 焊装
t202217 Gac123456!! 焊装 2厂
t202216 Gac123456!! 焊装
t202219 Gac123456!! 电池
t202205 Gac123456!! 电池
t202204 Gac123456!! 电池
t202202 Gac123456!! 电池</p>
<p>APP登录账号：
t202181/123456
t202182/123456
t202183/123456
t202180/123456
t202206/123456
t202207/123456
t202208/123456</p>
<p>广汽环境：
测试环境(广汽内网)：<a href="https://test-p2-cms.10-102-12-52.sslip.io">https://test-p2-cms.10-102-12-52.sslip.io</a>
账密:
t202159/Gac123456@@test 无车间
t202157/Gac123456@@test 冲压
t202156/Gac123456@@test 焊装
t202145/Gac123456@@test涂装
t202160/Gac123456@@test总装</p>
<p>更多账号请查看，修改密码后请登记
【腾讯文档】IAM_用户数据_临时账号_测试环境
<a href="https://docs.qq.com/sheet/DT0VieVZuTFpyRE1a?tab=BB08J2">https://docs.qq.com/sheet/DT0VieVZuTFpyRE1a?tab=BB08J2</a></p>
<p>生产环境：<a href="https://aimsii.gacne.com.cn/">https://aimsii.gacne.com.cn/</a>
账密:
t202180/Gac123456!!
t202181/Gac123456!!</p>
<p>IAM SSO登录（浏览器新标签打开时判断到用户未登录时）
测试环境：<a href="https://iamdev.gacne.com.cn:4443/oauth2/rest/authz?response_type=code&client_id=792e9c2eaa344188a89eb09fc4be9c16&domain=IAMDomain&state=smart_factory&scope=IAMResource.UserProfile.me">https://iamdev.gacne.com.cn:4443/oauth2/rest/authz?response_type=code&client_id=792e9c2eaa344188a89eb09fc4be9c16&domain=IAMDomain&state=smart_factory&scope=IAMResource.UserProfile.me</a> openid email phone profile&redirect_uri=<a href="http://test-p2-cms.10-102-12-52.sslip.io/cms/main">http://test-p2-cms.10-102-12-52.sslip.io/cms/main</a>
生产环境：
<a href="https://iam.gacne.com.cn:4443/oauth2/rest/authz?response_type=code&client_id=0f09b8d1d25a43bc94e7f8f61607e209&domain=IAMDomain&state=smart_factory&scope=IAMResource.UserProfile.me">https://iam.gacne.com.cn:4443/oauth2/rest/authz?response_type=code&client_id=0f09b8d1d25a43bc94e7f8f61607e209&domain=IAMDomain&state=smart_factory&scope=IAMResource.UserProfile.me</a> openid email phone profile&redirect_uri=<a href="https://aimsii.gacne.com.cn/cms/main">https://aimsii.gacne.com.cn/cms/main</a></p>
<p>IAM SSO 退出：（浏览器新标签打开时单独需要退出时）
测试环境：[GET] <a href="https://iamdev.gacne.com.cn:4443/oam/server/logout?end_url=https://iamdev.gacne.com.cn:4443/ssologin/login.jsp">https://iamdev.gacne.com.cn:4443/oam/server/logout?end_url=https://iamdev.gacne.com.cn:4443/ssologin/login.jsp</a>
生产环境：[GET] <a href="https://iam.gacne.com.cn:4443/oam/server/logout?end_url=https://iam.gacne.com.cn:4443/ssologin/login.jsp">https://iam.gacne.com.cn:4443/oam/server/logout?end_url=https://iam.gacne.com.cn:4443/ssologin/login.jsp</a></p>
<h1>一. 应用注册</h1>
<p>应用接入的Client_ID，Client_Secret信息，需要在应用注册页面进行填写信息后，得到相应的信息。
接入应用有三种情况：</p>
<ol>
<li>只接入用户登录鉴权
在应用注册页面中，只输入应用名，应用地址，选择应用类型，点击【确定】按钮进行保存。
添加的应用会在登录成功后，主页面左侧菜单中出现应用名，点击后跳转到相应的应用链接</li>
<li>接入用户登录鉴权+菜单链接
在应用注册页面中，输入应用名，应用地址，勾选接入模块 “统一菜单集成”，输入菜单地址
菜单地址返回数据格式请按以下格式：
<pre><code>{
&quot;code&quot;: 0,
&quot;message&quot;:&quot;&quot;,
&quot;payload&quot;: [{
&quot;id&quot;:&quot;1&quot;,//ID为字符型
&quot;parentId&quot;:&quot;0&quot;,//父ID, 根节点为0值
&quot;name&quot;:&quot;设备管理&quot;,//菜单名
&quot;url&quot;:&quot;&quot;//菜单相对地址,如果是目录，URL值给&quot;&quot;
},
{
&quot;id&quot;:&quot;2&quot;,
&quot;parentId&quot;:&quot;1&quot;,
&quot;name&quot;:&quot;设备列表&quot;,//菜单名
&quot;url&quot;:&quot;/equipment/list&quot;//菜单相对地址
},
{....}]
}</code></pre></li>
<li>接入用户登录鉴权+菜单链接+权限设置
在应用注册页面中，输入应用名，应用地址，勾选接入模块 “统一菜单集成”，输入菜单地址，勾选“统一权限管理”
后继权限资源录入，权限设置统一在公共模块进行，具体权限设置查看权限管理</li>
</ol>
<h1>二. 用户相关</h1>
<ul>
<li>
<h2>1. 获取当前登录用户信息[Token值由前端接收到后调用后台接口，后台请求公共模块]</h2>
<p>前端获取Token方法详见 <a href="https://docs.qq.com/slide/DT2pISWJKVklsVUVp">https://docs.qq.com/slide/DT2pISWJKVklsVUVp</a> 文档 5，6，7页 说明</p>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/oauth/current/user</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>POST /x-www-form-urlencoded </li>
</ul>
<p><strong>参数：</strong> </p>
<pre><code>token:&quot;xxxx&quot; </code></pre>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: {
&quot;index&quot;: null,
&quot;id&quot;: &quot;6c6330b7-8cfc-4ade-9e11-5428d7fa574a&quot;,
&quot;domain&quot;: &quot;冲压车间&quot;, --车间
&quot;account&quot;: &quot;t202102&quot;,
&quot;username&quot;: &quot;邹世钦&quot;,
&quot;sex&quot;: &quot;男&quot;,
&quot;mobile&quot;: &quot;13560227456&quot;,
&quot;email&quot;: &quot;default@gacne.com.cn&quot;,
&quot;category&quot;: &quot;直间人员&quot;,
&quot;position&quot;: &quot;设备技术员&quot;,
&quot;onboardingTime&quot;: &quot;2017/10/01&quot;,
&quot;status&quot;: 0,
&quot;superiorId&quot;: null,
&quot;superior&quot;: null,
&quot;superiorName&quot;: null,
&quot;agentId&quot;: null,
&quot;agent&quot;: null,
&quot;agentName&quot;: null,
&quot;orgCode&quot;: &quot;10000005&quot;,
&quot;orgName&quot;: &quot;冲压车间&quot;,
&quot;technicalList&quot;: [],
&quot;roleList&quot;: [
{
&quot;id&quot;: &quot;3&quot;,
&quot;roleName&quot;: &quot;所有人&quot;,
&quot;enable&quot;: 0,
&quot;count&quot;: null,
&quot;delete&quot;: 1
}
],
&quot;authorityInfo&quot;: [--权限集合
{
&quot;appId&quot;: &quot;5f934999-26a2-4de7-b563-fc8204257582&quot;,
&quot;appName&quot;: &quot;系统管理&quot;,
&quot;clientId&quot;: &quot;084ad33e-cbf6-4f3c-95f5-033a58c3f517&quot;,
&quot;authorityInfo&quot;: [--具体应用权限集
{
&quot;id&quot;: &quot;2&quot;,
&quot;modelName&quot;: &quot;系统管理&quot;,
&quot;modelParentId&quot;: &quot;0&quot;,
&quot;resourceId&quot;: null,
&quot;resourceName&quot;: null,
&quot;status&quot;: 0,
&quot;other&quot;: null,
&quot;appId&quot;: &quot;5f934999-26a2-4de7-b563-fc8204257582&quot;,
&quot;appName&quot;: &quot;系统管理&quot;,
&quot;clientId&quot;: &quot;084ad33e-cbf6-4f3c-95f5-033a58c3f517&quot;,
&quot;factoryCode&quot;:1
},
{
&quot;id&quot;: &quot;fdb3c4f2-0de0-46da-b98d-7185b2c3cd1c&quot;,
&quot;modelName&quot;: &quot;角色管理&quot;,
&quot;modelParentId&quot;: &quot;2&quot;,
&quot;resourceId&quot;: &quot;SYS-ROLE-M&quot;,
&quot;resourceName&quot;: &quot;角色管理&quot;,
&quot;status&quot;: 0,
&quot;other&quot;: &quot;&quot;,
&quot;appId&quot;: &quot;5f934999-26a2-4de7-b563-fc8204257582&quot;,
&quot;appName&quot;: &quot;系统管理&quot;,
&quot;clientId&quot;: &quot;084ad33e-cbf6-4f3c-95f5-033a58c3f517&quot;,
&quot;factoryCode&quot;:1
},
{
&quot;id&quot;: &quot;42f692f4-2369-4f2f-9ae7-d6a1185430db&quot;,
&quot;modelName&quot;: &quot;查看用户&quot;,
&quot;modelParentId&quot;: &quot;c5c97f91-3c72-4f54-8909-5a8960c430df&quot;,
&quot;resourceId&quot;: &quot;SYS-ORG-USER&quot;,
&quot;resourceName&quot;: &quot;查看用户&quot;,
&quot;status&quot;: 0,
&quot;other&quot;: &quot;&quot;,
&quot;appId&quot;: &quot;5f934999-26a2-4de7-b563-fc8204257582&quot;,
&quot;appName&quot;: &quot;系统管理&quot;,
&quot;clientId&quot;: &quot;084ad33e-cbf6-4f3c-95f5-033a58c3f517&quot;
},
{
......
}
]
}
],
&quot;factoryCode&quot;: 1, -- 厂区，1-一厂，2-二厂
&quot;theme&quot;: null-- 主题，用户没有设置则应用使用默认主题
}
}</code></pre>
<ul>
<li>
<h2>2.批量获取指定用户信息【2023-01-07修改】</h2>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/oauth/info/accounts?accounts=xxx,xxx</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>
<p>GET</p>
<pre><code>Authorization：xxxx 【2023-01-07修改】</code></pre>
<p><strong>返回示例</strong></p>
</li>
</ul>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: [
{
&quot;account&quot;: &quot;180100&quot;,
&quot;username&quot;: &quot;蔡龙德&quot;,
&quot;mobile&quot;: &quot;18033160837&quot;,
&quot;email&quot;: &quot;default@gacne.com.cn&quot;
},
{
&quot;account&quot;: &quot;18901&quot;,
&quot;username&quot;: &quot;张三&quot;,
&quot;mobile&quot;: &quot;10086&quot;,
&quot;email&quot;: &quot;default@gac.com&quot;
}
]
}</code></pre>
<ul>
<li>
<h2>3.1 批量获取用户信息(只返回姓名，工号,厂区，组织代码，组织名称, 上级主管，上级主管工号)</h2>
<p>【适用场景：下拉选择用户，同步数据基础信息】</p>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/open/oauth/user/message?account=xxxx&amp;pageNum=1&amp;pageSize=10</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>
<p>GET</p>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: {
&quot;page&quot;: true,
&quot;count&quot;: 1,
&quot;pageCount&quot;: 1,
&quot;pageNum&quot;: 1,
&quot;pageSize&quot;: 10,
&quot;data&quot;: [
{
&quot;index&quot;: null,
&quot;id&quot;: null,
&quot;domain&quot;: null,
&quot;account&quot;: &quot;170300&quot;,
&quot;username&quot;: &quot;王鹏洋&quot;,
&quot;sex&quot;: null,
&quot;mobile&quot;: null,
&quot;email&quot;: null,
&quot;category&quot;: null,
&quot;position&quot;: null,
&quot;onboardingTime&quot;: null,
&quot;status&quot;: 0,
&quot;superiorId&quot;: null,
&quot;superior&quot;: &quot;t10086&quot;, --上级主管工号
&quot;superiorName&quot;: &quot;张三&quot;, --上级主管姓名
&quot;agentId&quot;: null,
&quot;agent&quot;: null,
&quot;agentName&quot;: null,
&quot;orgCode&quot;: &quot;10010415&quot;,
&quot;orgName&quot;: &quot;工厂规划、数字化&quot;,
&quot;roleName&quot;: null,
&quot;technicalList&quot;: null,
&quot;roleList&quot;: null,
&quot;authorityInfo&quot;: null,
&quot;localRes&quot;: null,
&quot;factoryCode&quot;: 0,
&quot;theme&quot;: null,
&quot;accessToken&quot;: null,
&quot;orgIds&quot;: null
}
]
},
&quot;success&quot;: true
}</code></pre>
</li>
<li>
<h2>3.2 批量获取用户信息(请输入多些条件进行查询)</h2>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/open/oauth/user/list?account=xxxx&amp;domain=&amp;factoryCode=1&amp;orgCode=&amp;pageNum=1&amp;pageSize=10</code>
【2023/01/31更新：增加account、domain、orgCode至少输入一个搜索条件限制】</li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>
<p>GET</p>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: {
&quot;page&quot;: true,
&quot;count&quot;: 1,
&quot;pageCount&quot;: 1,
&quot;pageNum&quot;: 1,
&quot;pageSize&quot;: 10,
&quot;data&quot;: [{
&quot;index&quot;: null,
&quot;id&quot;: null,
&quot;domain&quot;: &quot;涂装&quot;,
&quot;account&quot;: &quot;t202180&quot;,
&quot;username&quot;: &quot;测试管理员（生产环境）&quot;,
&quot;sex&quot;: null,
&quot;mobile&quot;: null,
&quot;email&quot;: &quot;abc@123.com&quot;,
&quot;category&quot;: null,
&quot;position&quot;: null,
&quot;onboardingTime&quot;: null,
&quot;status&quot;: 0,
&quot;superiorId&quot;: null,
&quot;superior&quot;: &quot;t202207&quot;,
&quot;superiorName&quot;: &quot;沈宁远&quot;,
&quot;agentId&quot;: null,
&quot;agent&quot;: null,
&quot;agentName&quot;: null,
&quot;orgCode&quot;: null,
&quot;orgName&quot;: null,
&quot;roleName&quot;: &quot;冲压物流一厂生产班长,科长（物流）,物流最后审核人,测试1,品质组长（物流）,保全组长（焊装）,安东管理员,设备web管理员,安东App管理员,冲压物流一厂品质组长,仓库管理员,生产系长（物流）,冲压质量管理员,冲压物流一厂科长,生产计划员（物流）,普通管理员12,冲压物流一厂生产系长,质量管理员-test,设备APP（测试模具点检）不要动,权限资源管理员,公共模块测试2,ABC,物流第一审核人,模具APP,模具Web管理员,冲压物流一厂材料管理员,冲压物流一厂生产组长,amy-test33-999,test,冲压物流一厂申请系系长,设备技术员（焊装）,测试二个厂区权限,角色&amp;组织管理测试,pan1,aviAPP管理员,公共模块测试,模具APP管理员,系统管理/一般管理员,pan2,智能安灯一厂冲压管理员,智能安灯一厂焊装管理员,智能安灯一厂涂装管理员,智能安灯一厂总装管理员,智能安灯一厂冲压操作员,智能安灯一厂焊&quot;,
&quot;technicalList&quot;: null,
&quot;roleList&quot;: null,
&quot;authorityInfo&quot;: null,
&quot;localRes&quot;: null,
&quot;factoryCode&quot;: 1,
&quot;theme&quot;: null,
&quot;accessToken&quot;: null
}]
},
&quot;success&quot;: true
}</code></pre>
</li>
<li>
<h2>4.传入用户工号获取下属信息【2023-01-07修改】</h2>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/oauth/sbordinate/info?account=xxxx</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET</li>
</ul>
<pre><code> Authorization：xxxx 【2023-01-07修改】</code></pre>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: [
{
&quot;account&quot;: &quot;180296&quot;,
&quot;username&quot;: &quot;沈宁远&quot;,
&quot;mobile&quot;: &quot;18257220813&quot;,
&quot;email&quot;: &quot;default@gacne.com.cn&quot;
},
{
&quot;account&quot;: &quot;170345&quot;,
&quot;username&quot;: &quot;李赞云&quot;,
&quot;mobile&quot;: &quot;10086&quot;,
&quot;email&quot;: &quot;111113@gacne.com.cn&quot;
}
]
}</code></pre>
<ul>
<li>
<h2>5.传入用户工号获取上级主管</h2>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/open/oauth/user/list/param?account=xxxx</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>
<p>GET</p>
<pre><code>参数：account= 工号</code></pre>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: [{
&quot;superior&quot;: &quot;t202180&quot;,
&quot;superiorName&quot;: &quot;测试管理员（生产环境）&quot;
}],
&quot;success&quot;: true
}</code></pre>
</li>
<li>
<h2>6.APP重置密码</h2>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/oauth/editPassword</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>
<p>POST/form-data
```{
"account":"xxx",//工号
"onboardingTime":"",//入厂日期
"email":"",//邮箱
"password":"xxxx"//密码
}</p>
<pre><code>
**返回示例**</code></pre>
</li>
</ul>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;&quot;,--输入的入厂日期和邮箱与工号不匹配时修改失败信息
&quot;payload&quot;: {}
}</code></pre>
<ul>
<li>
<h2>7.APP接入登录</h2>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/oauth/token</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>
<p>POST/form-data</p>
<pre><code>grant_type:password,
username:{用户名},
password:{密码},
client_id:{client},-- 应用注册时返回的Client
client_secret:{secret} --应用注册时返回的Secret</code></pre>
<p><strong>返回示例</strong></p>
</li>
</ul>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;&quot;,
&quot;payload&quot;: {}
}</code></pre>
<ul>
<li>
<h2>8. APP退出登录</h2>
<p><strong>请求URL：</strong> </p>
</li>
<li><code>http://{host:port}/oauth/logout</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET</li>
</ul>
<p><strong>参数：</strong>
header:
Authorization: "Bearer {token}" --Header传入token</p>
<ul>
<li>
<h2>9. Web端退出登录</h2>
<p>【公共模块退出，PostMessage 消息给到各打开的Tab页面】
前端 => 调用自己应用的后台接口 => 公共模块退出接口 => 返回成功状态 => 后台删除Redis等缓存信息 => 前端删除用户信息</p>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/oauth/current/user/exit</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>POST</li>
</ul>
<p><strong>参数：</strong>
token
<strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;&quot;,
&quot;payload&quot;: {}
}</code></pre>
<h1>三. 角色管理</h1>
<ul>
<li>
<h2>3.1 获取角色列表【2023-01-07修改】</h2>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/role/role/list?roleName=&amp;isAll=all</code> -- isAll=all 查所有角色，如果不传或其它值，则默认查当前用户角色</li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET </li>
</ul>
<p><strong>参数：</strong>
```header中加入
Authorization：xxxx 【2023-01-07修改】</p>
<pre><code>
**返回示例**
</code></pre>
<p>{
"code": 0,
"errmsg": "Success",
"payload": [
{
"index": 1,
"id": "2",
"roleName": "系统管理员", -- 角色名
"status": 0, --状态，0正常，1禁用
"isEdit": 1, --是否可修改
"count": 1 --角色下人数
}
]
}</p>
<pre><code>
- ## 3.2 获取角色下用户列表【2023-01-07修改】
**请求URL：**
- ` http://{host:port}/oauth/user/list` -- 修改请求接口
**请求方式：**
- POST
```header中加入
Authorization：xxxx 【2023-01-07修改】</code></pre>
<p><strong>请求参数：</strong></p>
<pre><code>{
&quot;pageNum&quot;: 1,
&quot;pageSize&quot;: 10,
&quot;roleId&quot;: &quot;a29d8e41-c2b7-4430-a0c9-fed7bdbbefc9&quot;
}</code></pre>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: {
&quot;count&quot;: 1,
&quot;pageCount&quot;: 1,
&quot;pageNum&quot;: 1,
&quot;pageSize&quot;: 20,
&quot;data&quot;: [
{
&quot;index&quot;: 1,
&quot;id&quot;: &quot;8052de52-e45e-4ae6-9a40-a4c1980c79261&quot;,
&quot;domain&quot;: &quot;焊装&quot;,
&quot;account&quot;: &quot;t202182&quot;,
&quot;username&quot;: &quot;陆伟泉&quot;,
&quot;sex&quot;: &quot;1&quot;,
&quot;mobile&quot;: &quot;889220&quot;,
&quot;email&quot;: &quot;1443@gac.com&quot;,
&quot;category&quot;: &quot;直接&quot;,
&quot;position&quot;: &quot;大灯调整生产员&quot;,
&quot;onboardingTime&quot;: &quot;2019/12/02&quot;,
&quot;status&quot;: 0,
&quot;superiorId&quot;: &quot;85fcfbf5-79f3-4de5-8a9f-db7254e4a2d2&quot;,
&quot;superior&quot;: &quot;t202200&quot;,
&quot;superiorName&quot;: &quot;石紫文&quot;,
&quot;agentId&quot;: null,
&quot;agent&quot;: null,
&quot;agentName&quot;: null,
&quot;orgCode&quot;: null,
&quot;orgName&quot;: null,
&quot;roleName&quot;: null,
&quot;technicalList&quot;: [],
&quot;roleList&quot;: [
{
&quot;id&quot;: &quot;04bb25c1-9ae9-4d4f-9ade-46879e19c935&quot;,
&quot;roleName&quot;: &quot;CopyMAGA&quot;,
&quot;role&quot;: &quot;ROLE_USER&quot;,
&quot;enable&quot;: 0,
&quot;count&quot;: null,
&quot;delete&quot;: 0,
&quot;roleTag&quot;: null,
&quot;createBy&quot;: null
}
],
&quot;authorityInfo&quot;: null,
&quot;localRes&quot;: null,
&quot;factoryCode&quot;: 1,
&quot;theme&quot;: &quot;blue&quot;,
&quot;accessToken&quot;: null,
&quot;orgIds&quot;: null
}
]
},
&quot;success&quot;: true
}</code></pre>
<h1>四. 组织管理</h1>
<ul>
<li>
<h2>4.1 获取组织列表 【2023-01-07修改】</h2>
</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/open/org/list?organizeName=</code> -- 树型结构， 开放接口，不需要token 【2023-01-10 增加】</li>
<li><code>http://{host:port}/organize/org/ping/list</code> -- 平铺结构</li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET </li>
</ul>
<p>```header中加入
Authorization：xxxx 【2023-01-07修改】</p>
<pre><code>
**返回示例**
</code></pre>
<p>{
"code": 0,
"errmsg": "Success",
"payload": [
{
"orgCode": "10000001",
"orgName": "广汽埃安",
"orgEnName": "GACNE",
"orgLevel": null,
"orgLevelName": "公司",
"activeDate": null,
"endDate": null,
"fullOrgCode": null,
"fullOrgName": null,
"parentOrgCode": "0",
"parentOrgName": null,
"status": "ENABLE",
"factoryCode": null,
"costCenter": null,
"costCenterName": null,
"account": "180105",
"accountName": "欧阳文",
"organizeVOList": [
{
"orgCode": "10000002",
"orgName": "广汽埃安新能源汽车有限公司",
"orgEnName": "GACNE",
"orgLevel": null,
"orgLevelName": "公司",
"activeDate": null,
"endDate": null,
"fullOrgCode": null,
"fullOrgName": null,
"parentOrgCode": "10000001",
"parentOrgName": null,
"status": "ENABLE",
"factoryCode": null,
"costCenter": null,
"costCenterName": null,
"account": "180128",
"accountName": "陆光维",
"organizeVOList": [
{
"orgCode": "10000003",
"orgName": "第一智造中心",
"orgEnName": "GACNE",
"orgLevel": null,
"orgLevelName": "制造处",
"activeDate": null,
"endDate": null,
"fullOrgCode": null,
"fullOrgName": null,
"parentOrgCode": "10000002",
"parentOrgName": null,
"status": "ENABLE",
"factoryCode": null,
"costCenter": null,
"costCenterName": null,
"account": "180105",
"accountName": "欧阳文",
"organizeVOList": [
{
"orgCode": "10000005",
"orgName": "冲压车间",
"orgEnName": "GACNE",
"orgLevel": null,
"orgLevelName": "车间",
"activeDate": null,
"endDate": null,
"fullOrgCode": null,
"fullOrgName": null,
"parentOrgCode": "10000003",
"parentOrgName": null,
"status": "ENABLE",
"factoryCode": null,
"costCenter": "NE502040",
"costCenterName": null,
"account": "star",
"accountName": "staro",
"organizeVOList": null
},
{
"orgCode": "10000006",
"orgName": "焊装车间",
"orgEnName": "GACNE",
"orgLevel": null,
"orgLevelName": "车间",
"activeDate": null,
"endDate": null,
"fullOrgCode": null,
"fullOrgName": null,
"parentOrgCode": "10000003",
"parentOrgName": null,
"status": "ENABLE",
"factoryCode": null,
"costCenter": "NE502041",
"costCenterName": null,
"account": null,
"accountName": null,
"organizeVOList": null
}
]
},
{
"orgCode": "10000004",
"orgName": "第二智造中心",
"orgEnName": "GACNE",
"orgLevel": null,
"orgLevelName": "制造处",
"activeDate": null,
"endDate": null,
"fullOrgCode": null,
"fullOrgName": null,
"parentOrgCode": "10000002",
"parentOrgName": null,
"status": "ENABLE",
"factoryCode": null,
"costCenter": null,
"costCenterName": null,
"account": "180128",
"accountName": "陆光维",
"organizeVOList": null
}
]
}
]
}
]
}</p>
<pre><code>
- ## 4.2 获取组织下用户列表
参数详见【## 3.2 批量获取用户信息】传入具体的orgcode
- ## 4.3 获取指定组织信息
**请求URL：**
- ` http://{host:port}/open/organize/info/new?orgCode=xxx `
**请求方式：**
- GET
**返回示例**
</code></pre>
<p>{
"code": 0,
"errmsg": "Success",
"payload": {
"orgCode": "10010414",
"orgName": "冲压",
"orgEnName": "GACNE",
"orgLevel": "3",
"orgLevelName": "科",
"activeDate": "2021-10-22 00:00:00",
"endDate": "9999-12-31 00:00:00",
"fullOrgCode": "10000000>10000001>10000055>10000073>10010414",
"fullOrgName": "广汽埃安>广汽埃安新能源汽车有限公司>整车技术中心>工艺部>冲压",
"parentOrgCode": "10000073",
"parentOrgName": "工艺部",
"status": "ENABLE",
"factoryCode": "0",
"costCenter": null,
"costCenterName": null,
"account": null,
"accountName": null,
"userId": null,
"createTime": null,
"isExcel": null,
"organizeVOList": null
},
"success": true
}</p>
<pre><code>
# 五. 权限资源管理
应客户胡锡雄提的需求，广汽所有应用，权限统一管理，统一配置，用户，角色可以一下看到他在各应用下的权限。
当页面没有权限时，页面跳转到404，提示“您所访问的资源不存在”；
当按钮没有权限时，按钮进行隐藏；
当数据没有权限时，后台数据查询不查询出来，页面不显示相应字段或用“/”替代。
- ## 5.1. 添加权限项
**请求URL：**
- ` http://{host:port}/auth/add/point `
**请求方式：**
- POST
**参数：**
header:
Authorization: &quot;Bearer {token}&quot; --Header传入token
body: json</code></pre>
<p>{
"appId": "198e2d8f-d6f1-40df-a2d7-d5943993ccd7",//应用id
"pointParentId": "fe25a7e4-664f-4f5b-84d6-674f3647c882", //你节点
"resourceId": "aps-test",//资源ID
"resourceName": "测试节点",//资源名
"pointName": "测试节点",//资源名
"other": "",//资源说明
"status": 0//0- 启用，1-禁用
}</p>
<pre><code>
返回</code></pre>
<p>{
"code": 0,//0-成功，其它值为失败
"errmsg": "Success",
"payload": null
}</p>
<pre><code>
- ## 5.2. 删除权限项
**请求URL：**
- ` http://{host:port}/auth/remove/point `
**请求方式：**
- POST
**参数：**
header:
Authorization: &quot;Bearer {token}&quot; --Header传入token
body: **Form Data**</code></pre>
<p>appId:198e2d8f-d6f1-40df-a2d7-d5943993ccd7
pointId:4dc15397-63fc-46b3-8bd0-317073c21bbb</p>
<pre><code>
返回</code></pre>
<p>{
"code": 0,//0-成功，其它值为失败
"errmsg": "Success",
"payload": null
}</p>
<pre><code>
# 六. 统一菜单接入接口
- ## 各应用返回当前登录用户**有权限**的菜单列表
**请求URL示例：**
- GET ` http://{host:port}/xxx/getUserMenus `
-- 1. 菜单地址可自定义，GET方式
-- 2. 菜单地址在应用注册时录入到配置中（如果应用注册时勾选了“统一菜单集成”）
-- 3. **调用接口Header头Authorization传入&quot;Bearer {Token}&quot;，可用于获取当前用户信息，以验证用户有权限的菜单是哪些**
**请求方式：**
- GET
**返回示例**
</code></pre>
<p>{
"code": 0,
"message":"",
"payload": [{
"id":"1", --ID为字符型
"parentId":"0", --父ID, 根节点为0值
"name":"设备管理",-- 菜单名
"url":""--菜单相对地址,如果是目录，URL值给""
},
{
"id":"2",
"parentId":"1",
"name":"设备列表",
"url":"/equipment/list"
}]
}</p>
<pre><code>
**返回参数说明**
请&lt;font color=&quot;red&quot;&gt;**参照上面的格式**&lt;/font&gt;，如果菜单树有多级目录，平铺展开数据，树形菜单由公共模块前端组织
## Q&amp;A：
### 1. 系统已经有自己的左侧菜单和顶部导航，要怎么集成？
A: 返回的菜单可加上参数，如 /equipment/list?isHidenFlag=true, 页在打开时，隐藏左侧菜单和顶部导航，做到单独部署也可以有自己的菜单，&quot;isHidenFlag&quot; 参数可系统自行定义
### 2. 没有做登录对接与权限管理，要怎么处理？
A: 先确保本次6.30演示的功能列表，返回，后期对接用户，设置权限，再返回相应用户有权限的菜单
### 3. 为什么公共模块不增加菜单配置进行统一菜单管理？
A: 解偶，应用增加、删除页面自行维护,减少与其它系统的依赖与注册操作
# 七. 消息中心
</code></pre>
<p>RabbitMQ 测试环境:
gost -L tcp://127.0.1.10:5672/rabbitmq-user-root.rabbitmq-1:5672 -F socks5+mws://gost-mws.10-124-130-142.sslip.io:80
test/123456</p>
<pre><code>消息中心采用MQ进行系统解偶，按以下json格式发送消息到 RabbitMQ 服务器中的 gac_message_queue 队列中
## 7.1 消息格式</code></pre>
<p>{
"from": "设备叫修", //发送方(必填)
"recipient": "170300", //接收方(必填)：工号,多个用英文逗号隔开
"messageType": "normal", //消息类型(必填)：normal(普通消息)/todo(待办事项)
"subject": "【设备故障】xxxxxxxxxx", //消息标题(必填)
"message": "//json字符串（选填），可用于自定义数据呈现，消息中心不呈现给用户",
"content": "xxxxx,xxxxxx", //消息内容(必填) 消息内容太长时（>500字时，建议传入下面的URL地址，用户点击查看详情进页面查看）
"coverImageUrl":"<a href="http://图片完整URL地址",//图片类型时传入图片地址（选填,messagesSendFormart:image">http://图片完整URL地址",//图片类型时传入图片地址（选填,messagesSendFormart:image</a> 必填）
"url":"",//链接地址（选填）
"time":"2021-09-09 13:05"//消息发生时间(必填)
"sending": "app,mail,wechat", //发送途径(必填)：app，mail，wechat,多个用英文逗号隔开
"todoId": "xxxxxxxx", //待办事项ID(UUID)-当消息类型为todo时必填
"messagesSendFormart":"news/markdown/image"//消息发送格式，如果没有传，默认news
}</p>
<pre><code>
待办事项更新状态 发送消息到 gac_message_status_queue 队列</code></pre>
<p>[{
"todoId": "xxxxxxxx",
"status": 1 //处理中
}, {
"todoId": "xxxxxxxx",
"status": 2 //已完成
}, {
"todoId": "xxxxxxxx",
"status": 3 //删除
}]</p>
<pre><code>
## 7.2 消息中心接口
### 7.2.1. 消息列表
**请求URL：**
- ` http://{host:port}/message/list?messageType=normal&amp;pageNum=1&amp;pageSize=10&amp;token=dDIwMjE4MA==WEB `
- messageType : normal 站内消息，todo 待办
**请求方式：**
- GET
**参数：**
**返回示例**
</code></pre>
<p>{
"code": 0,
"errmsg": "Success",
"payload": {
"count": 40,
"pageCount": 4,
"pageNum": 1,
"pageSize": 10,
"data": [{
"id": "fa50311d-4551-45ff-9dc4-06a020b6c18e",
"subject": "安全告知",
"content": "【安全告知】：工事任务G20210927150558009涉及安全作业，更多注意事项请查看工单详情",
"url": "<a href="http://106.52.232.176/gx/Urgency/ModelDetail/G20210927150558009"">http://106.52.232.176/gx/Urgency/ModelDetail/G20210927150558009"</a>;,
"status": "0", --状态，0-未开始，1-处理中，2-完成
"isRead": 0, --是否已读 0 未读，1 已读
"receiveDate": "2021-09-27 23:05:58"
}]
}
}</p>
<pre><code>
### 2.2. 删除消息
**请求URL：**
- ` http://{host:port}/message/remove `
**请求方式：**
- POST
**参数：**
header:
Authorization: &quot;Bearer {token}&quot;
Form Data:
ids: ｛消息id｝
**返回示例**
</code></pre>
<p>{"code":0,"errmsg":"Success","payload":null}</p>
<pre><code>
# 生产日历
**请求URL：**
- ` http://{host:port}/system/product/calendar/list?areaCode=WE&amp;factoryCode=1300&amp;month=2023-04`
**请求方式：**
- GET
**参数：**
header:
Authorization: &quot;openApi&quot;
areaCode=
冲压车间 PR
焊装车间 WE
涂装车间 PA
总装车间 AF
质量车间 VQ
factoryCode=1000/1300 // 一厂1000,二厂1300
month=2023-04 //具体月份
**返回示例**
</code></pre>
<p>shiftCode：0-早班，1-中班
areaCode:原始同步过来的值，可以忽略不用看</p>
<pre><code>
# 八. 知识库
## 作业文档
### 8.1. 作业文档接口【2023-01-07修改】
**请求URL：**
- ` http://{host:port}/doc/list`
**请求方式：**
- POST
**参数：**
```header中加入
Authorization：xxxx 【2023-01-07修改】</code></pre>
<p>body: json</p>
<pre><code>{
&quot;key_word&quot;: &quot;xxxx&quot;, //搜索关键字
&quot;page_num&quot;: 1,
&quot;page_size&quot;: 20
}</code></pre>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: {
&quot;count&quot;: 22,
&quot;pageCount&quot;: 2,
&quot;pageNum&quot;: 1,
&quot;pageSize&quot;: 20,
&quot;data&quot;: [
{
&quot;docId&quot;: &quot;37&quot;, //文档ID
&quot;docCode&quot;: &quot;Word12&quot;,//文档编号
&quot;docName&quot;: &quot;sdf&quot;,//文档名
&quot;version&quot;: &quot;1&quot;,//文档最新版本号
&quot;docDesc&quot;: &quot;&quot;,//文档描述
&quot;assetType&quot;: &quot;设备&quot;,//资产类型，是设备还是模具
&quot;equipmentType&quot;: &quot;&quot;, //资产类型
&quot;equipmentCode&quot;: &quot;&quot;, //资产代码
&quot;typeName&quot;: &quot;冲压车间文档&quot;,//文档类型
&quot;typeId&quot;: &quot;13&quot;,//文档类型ID
&quot;binding&quot;: false, //是否绑定资产
&quot;fileId&quot;: &quot;80&quot;, //附件ID
&quot;fileName&quot;: &quot;0820任务Word12sdf1.doc&quot;, //附件名
&quot;preview&quot;: true//是否支持在线预览
}
]
}
}</code></pre>
<h3>8.2. 作业文档 - 附件下载【2023-01-07修改】</h3>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/doc/downloadurl?doc_id=｛docId｝</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>Get </li>
</ul>
<p><strong>参数：</strong>
```header中加入
Authorization：xxxx 【2023-01-07修改】</p>
<pre><code>
**返回示例**
使用Payload中返回URL下载文件
</code></pre>
<p>{
"code": 0,
"errmsg": "Success",
"payload": "<a href="http://minio01.10-124-130-142.sslip.io/gac-cms-file/document/DOC1%E6%B8%85%E6%B4%97%E6%9C%BA%E6%93%8D%E4%BD%9C%E6%89%8B%E5%86%8C1.1_c0006197-fedc-4228-8892-0fbf56dbb3d3.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20210915%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210915T083740Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f960531fcaffb9ded4697d4920267f6231b6c907e5f05fd2028873367528517e"">http://minio01.10-124-130-142.sslip.io/gac-cms-file/document/DOC1%E6%B8%85%E6%B4%97%E6%9C%BA%E6%93%8D%E4%BD%9C%E6%89%8B%E5%86%8C1.1_c0006197-fedc-4228-8892-0fbf56dbb3d3.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20210915%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210915T083740Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f960531fcaffb9ded4697d4920267f6231b6c907e5f05fd2028873367528517e"</a>;
}</p>
<pre><code>
### 8.3. 作业文档 - 附件 - 历史版本列表接口【2023-01-07修改】
**请求URL：**
- ` http://{host:port}/doc/history?doc_id=｛作业文档ID｝&amp;page_num=1&amp;page_size=10`
**请求方式：**
- GET
**参数：**
```header中加入
Authorization：xxxx 【2023-01-07修改】</code></pre>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: {
&quot;count&quot;: 1,
&quot;pageCount&quot;: 1,
&quot;pageNum&quot;: 1,
&quot;pageSize&quot;: 10,
&quot;data&quot;: [
{
&quot;doc_id&quot;: &quot;9&quot;,
&quot;version&quot;: &quot;1.0&quot;,
&quot;file_id&quot;: &quot;10&quot;,//文件ID
&quot;file_name&quot;: &quot;DOC1清洗机操作手册1.0.doc&quot;,//附件名
&quot;preview&quot;: false,
&quot;update_time&quot;: &quot;2021-08-19 10:19:37&quot;
}
]
}
}</code></pre>
<h2>九.培训项目</h2>
<h3>9.1. 培训项目列表接口【2023-01-07修改】</h3>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/project/list?keyword={xxxx}&amp;page_num=1&amp;page_size=20</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET </li>
</ul>
<p><strong>参数：</strong>
```header中加入
Authorization：xxxx 【2023-01-07修改】</p>
<pre><code>
**返回示例**
</code></pre>
<p>{
"code": 0,
"errmsg": "Success",
"payload": {
"count": 4,
"pageCount": 1,
"pageNum": 1,
"pageSize": 20,
"data": [
{
"id": "15",//培训项目ID
"project_code": "C10201", //培训项目编号
"project_name": "设备基本操作",//培训项目名称
"project_desc": "",//培训项目说明
"count": 2 //课程数量
}
]
}
}</p>
<pre><code>
### 9.2. 培训项目 - 课程接口【2023-01-07修改】
**请求URL：**
- ` http://{host:port}/project/course/list?project_id={培训项目ID}`
**请求方式：**
- GET
**参数：**
```header中加入
Authorization：xxxx 【2023-01-07修改】</code></pre>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: [
{
&quot;id&quot;: &quot;12&quot;,//课程ID
&quot;course_code&quot;: &quot;C010103&quot;,//课程编号
&quot;course_name&quot;: &quot;研配机作业标准书系列&quot;,//课程名称
&quot;ability_detail&quot;: &quot;能进行研配机的基本操作&quot;,//考核内容
&quot;training_duration&quot;: &quot;3h&quot;,//培训时长
&quot;practice_duration&quot;: &quot;1周&quot;,//练习时长
&quot;examine_duration&quot;: &quot;1h&quot;,//考核时长
&quot;examine_details&quot;: &quot;研配机的基本操作&quot;,//考核内容
&quot;count&quot;: 2 //附件数
},
{
&quot;id&quot;: &quot;11&quot;,
&quot;course_code&quot;: &quot;C1010102&quot;,
&quot;course_name&quot;: &quot;压力机作业标准书系列&quot;,
&quot;ability_detail&quot;: &quot;能进行压力机及液压垫的基本操作&quot;,
&quot;training_duration&quot;: &quot;4h&quot;,
&quot;practice_duration&quot;: &quot;2周&quot;,
&quot;examine_duration&quot;: &quot;1h&quot;,
&quot;examine_details&quot;: &quot;压力机及液压垫操作&quot;,
&quot;count&quot;: 0
}
]
}</code></pre>
<h3>9.3. 培训项目 - 课程附件列表 接口【2023-01-07修改】</h3>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/project/course/annex/list?course_id=｛课程ID｝</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET </li>
</ul>
<p><strong>参数：</strong>
```header中加入
Authorization：xxxx 【2023-01-07修改】</p>
<pre><code>
**返回示例**
</code></pre>
<p>{
"code": 0,
"errmsg": "Success",
"payload": [
{
"id": "68", //附件ID
"file_name": "研配机作业标准书系列数字化决策+报表查询+KPI+20210825 (2).xls1.xls", //附件名
"preview": true,
"version": "1", //最新版本号
"createTime": "2021-08-25 15:49:55"
},
{
"id": "64",
"file_name": "研配机作业标准书系列0820任务.doc1.doc",
"preview": true,
"version": "1",
"createTime": "2021-08-25 15:46:42"
}
]
}</p>
<pre><code>
### 9.4. 培训项目 - 课程 - 附件 - 下载接口【2023-01-07修改】
**请求URL：**
- ` http://{host:port}/project/course/annex/download?file_id=｛附件ID｝`
**请求方式：**
- GET
**参数：**
```header中加入
Authorization：xxxx 【2023-01-07修改】</code></pre>
<p><strong>返回示例</strong>
使用Payload中URL下载文件本地查看</p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: &quot;http://minio01.10-124-130-142.sslip.io/gac-cms-file/projectcourse/%E7%A0%94%E9%85%8D%E6%9C%BA%E4%BD%9C%E4%B8%9A%E6%A0%87%E5%87%86%E4%B9%A6%E7%B3%BB%E5%88%97%E6%95%B0%E5%AD%97%E5%8C%96%E5%86%B3%E7%AD%96%2B%E6%8A%A5%E8%A1%A8%E6%9F%A5%E8%AF%A2%2BKPI%2B20210825%20%282%29.xls1_bccdf1ac-635d-4231-97e2-c60d0125690c.xls?X-Amz-Algorithm=AWS4-HMAC-SHA256&amp;X-Amz-Credential=admin%2F20210915%2Fus-east-1%2Fs3%2Faws4_request&amp;X-Amz-Date=20210915T085653Z&amp;X-Amz-Expires=604800&amp;X-Amz-SignedHeaders=host&amp;X-Amz-Signature=d60d2b1e6761bf8454863060e3c898b10ab74034c7ed854db8eb1c921984263d&quot;
}</code></pre>
<h4>9.5. 培训项目 - 课程 - 附件 - 历史版本列表接口</h4>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/project/course/annex/history?file_id=｛附件ID｝&amp;page_num=1&amp;page_size=10</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET </li>
</ul>
<p><strong>参数：</strong>
```header中加入
Authorization：xxxx 【2023-01-07修改】</p>
<pre><code>
**返回示例**
使用Payload中URL下载文件本地查看</code></pre>
<p>{
"code": 0,
"errmsg": "Success",
"payload": {
"count": 3,
"pageCount": 1,
"pageNum": 1,
"pageSize": 10,
"data": [
{
"id": "65", //附件ID
"file_name": "研配机作业标准书系列0824开发周会纪要.doc1.doc", //附件名
"preview": true,
"version": "1.1",//版本号
"createTime": "2021-08-25 15:48:23"
},
{
"id": "66",
"file_name": "研配机作业标准书系列信润录屏旁白信息收集-20210823(調整產品順序).xlsx1.xlsx",
"preview": true,
"version": "1.2",
"createTime": "2021-08-25 15:48:31"
},
{
"id": "67",
"file_name": "研配机作业标准书系列数字化决策+报表查询+KPI+20210825.xls1.xls",
"preview": true,
"version": "1.3",
"createTime": "2021-08-25 15:49:55"
}
]
}
}</p>
<pre><code>
# 十. 学习相关接口
## 10.1. 学习任务推送 【2023-01-07修改】
### 1). 准备课程数据
**请求URL：**
- ` http://{host:port}/study/user/list` -- 获取用户列表
- ` http://{host:port}/project/list` -- 获取课程列表
- ` http://{host:port}/project/course/list?project_id={课程id}` -- 获取课程目录列表
**请求方式：**
- GET
```header中加入
Authorization：xxxx 【2023-01-07修改】</code></pre>
<h3>2). 任务推送</h3>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/study/create/task</code> </li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>POST</li>
</ul>
<p><strong>参数</strong></p>
<pre><code>{
&quot;course_ids&quot;: [&quot;16&quot;, &quot;15&quot;], -- 课程信息
&quot;user_ids&quot;: [&quot;4105a8b2-5cf3-47a8-805b-1ea0924579a9&quot;, &quot;b4ee2217-e23e-4590-a846-4cac2f31f999&quot;] --用户id
}</code></pre>
<p><strong>返回示例：</strong> </p>
<pre><code>{&quot;code&quot;:0,&quot;errmsg&quot;:&quot;Success&quot;,&quot;payload&quot;:null}</code></pre>
<h2>10.2. 学习任务【2023-01-07修改】</h2>
<h3>1). 学习列表</h3>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/study/task?pageNum=1&amp;pageSize=10&amp;status=false</code> </li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET</li>
</ul>
<p>```header中加入
Authorization：xxxx 【2023-01-07修改】</p>
<pre><code>
**返回示例：** </code></pre>
<p>{
"code": 0,
"errmsg": "Success",
"payload": {
"count": 1,
"pageCount": 1,
"pageNum": 1,
"pageSize": 1,
"data": [{
"id": "11",
"task_num": "STM20210103071569", -- 任务编号
"create_time": "2021-10-30 08:20:39",
"complete_time": null,
"projects": [{
"project_id": "9",
"project_name": "测试002", -- 培训项目名
"courses": [{
"course_id": "16",-- 培训课程ID
"course_name": "abca", -- 培训课程名
"course_code": "111",
"ability_detail": "",
"status": "0" -- 学习状态，1 已学习，0 未学习
}]
}, {
"project_id": "8",
"project_name": "测试课程",
"courses": [{
"course_id": "15",
"course_name": "test",
"course_code": "ttest001",
"ability_detail": "x",
"status": "0"
}]
}]
}]
}
}</p>
<pre><code>
### 2). 学习附件
**请求URL：**
- ` http://{host:port}/study/course/annex/list?course_id={培训课程ID}&amp;task_id={学习任务id}` -- 如上数据 course_id=15&amp;task_id=11
**请求方式：**
- GET
```header中加入
Authorization：xxxx 【2023-01-07修改】</code></pre>
<p><strong>返回示例：</strong> </p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: [{
&quot;id&quot;: &quot;48&quot;,
&quot;file_name&quot;: &quot;0820任务test1.doc&quot;,
&quot;preview&quot;: true,
&quot;version&quot;: &quot;1&quot;,
&quot;createTime&quot;: &quot;2021-10-30 08:01:23&quot;,
&quot;status&quot;: &quot;0&quot;
}]
}</code></pre>
<h3>3). 学习完成</h3>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/study/complete?task_id=｛学习任务id｝&amp;file_ids={文件id}</code> -- 如上数据 /study/complete?task_id=11&file_ids=48</li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET
```header中加入
Authorization：xxxx 【2023-01-07修改】
<pre><code></code></pre></li>
</ul>
<p><strong>返回示例：</strong> </p>
<pre><code>{&quot;code&quot;:0,&quot;errmsg&quot;:&quot;Success&quot;,&quot;payload&quot;:null}</code></pre>
<h2>10.3. 员工学习记录</h2>
<h3>1). 员工学习记录列表</h3>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/study/task/user/list?keyword=&amp;page_num=1&amp;page_size=10</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET
```header中加入
Authorization：xxxx 【2023-01-07修改】
<pre><code></code></pre></li>
</ul>
<p><strong>返回示例：</strong> </p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: {
&quot;count&quot;: 2,
&quot;pageCount&quot;: 1,
&quot;pageNum&quot;: 1,
&quot;pageSize&quot;: 10,
&quot;data&quot;: [{
&quot;id&quot;: &quot;b4ee2217-e23e-4590-a846-4cac2f31f999&quot;,
&quot;domain&quot;: &quot;焊装车间&quot;,
&quot;account&quot;: &quot;zsshz2&quot;,
&quot;username&quot;: &quot;zss焊装2&quot;,
&quot;password&quot;: null,
&quot;sex&quot;: null,
&quot;mobile&quot;: null,
&quot;email&quot;: null,
&quot;enabled&quot;: 0,
&quot;category&quot;: null,
&quot;position&quot;: &quot;上车体A班保全员&quot;,
&quot;onboardingTime&quot;: null,
&quot;onboarding_time&quot;: null,
&quot;superiorId&quot;: null,
&quot;superior&quot;: null,
&quot;superiorName&quot;: null,
&quot;agentId&quot;: null,
&quot;agent&quot;: null,
&quot;agentName&quot;: null,
&quot;organizeId&quot;: &quot;59ea5f78-c3c7-48f9-b560-94a7081cfc2b&quot;,
&quot;organizeName&quot;: &quot;上车体A班&quot;,
&quot;technicalList&quot;: [],
&quot;roleList&quot;: null
}, {
&quot;id&quot;: &quot;4105a8b2-5cf3-47a8-805b-1ea0924579a9&quot;,
&quot;domain&quot;: &quot;焊装车间&quot;,
&quot;account&quot;: &quot;zsshz&quot;,
&quot;username&quot;: &quot;zss焊装&quot;,
&quot;password&quot;: null,
&quot;sex&quot;: null,
&quot;mobile&quot;: null,
&quot;email&quot;: null,
&quot;enabled&quot;: 0,
&quot;category&quot;: null,
&quot;position&quot;: &quot;上车体A班保全员&quot;,
&quot;onboardingTime&quot;: null,
&quot;onboarding_time&quot;: null,
&quot;superiorId&quot;: null,
&quot;superior&quot;: null,
&quot;superiorName&quot;: null,
&quot;agentId&quot;: null,
&quot;agent&quot;: null,
&quot;agentName&quot;: null,
&quot;organizeId&quot;: &quot;59ea5f78-c3c7-48f9-b560-94a7081cfc2b&quot;,
&quot;organizeName&quot;: &quot;上车体A班&quot;,
&quot;technicalList&quot;: [],
&quot;roleList&quot;: null
}]
}
}</code></pre>
<h3>2). 员工学习记录明细</h3>
<p><strong>请求URL：</strong> </p>
<ul>
<li><code>http://{host:port}/study/user/record?user_id={用户id}</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET</li>
</ul>
<p><strong>返回示例：</strong> </p>
<pre><code>{
&quot;code&quot;: 0,
&quot;errmsg&quot;: &quot;Success&quot;,
&quot;payload&quot;: [{
&quot;task_num&quot;: &quot;STM20210103071569&quot;,
&quot;course_code&quot;: &quot;ttest001&quot;,
&quot;course_name&quot;: &quot;test&quot;,
&quot;create_time&quot;: &quot;2021-10-30 08:20:39&quot;,
&quot;complete_time&quot;: &quot;2021-10-30 08:31:10&quot;,
&quot;status&quot;: &quot;1&quot;, -- 学习状态，1 已学习，0 未学习
&quot;technicalList&quot;: []
}, {
&quot;task_num&quot;: &quot;STM20210103071569&quot;,
&quot;course_code&quot;: &quot;111&quot;,
&quot;course_name&quot;: &quot;abca&quot;,
&quot;create_time&quot;: &quot;2021-10-30 08:20:39&quot;,
&quot;complete_time&quot;: null,
&quot;status&quot;: &quot;0&quot;,
&quot;technicalList&quot;: []
}]
}</code></pre>