You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
QingLong/Doc/v1.0/com_dsideal_QingLong_DataSh...

533 lines
23 KiB

7 months ago
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>DataShareController</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/css/bootstrap.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/font-awesome@4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/google-code-prettify@1.0.5/bin/prettify.min.css">
<link rel="stylesheet" href="style.css">
</head>
<body onload="PR.prettyPrint()">
<nav class="navbar">
<div class="container-fluid">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">
QingLong
</a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<li><a href="https://github.com/YeDaxia/JApiDocs" target="_blank">GitHub</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v1.0<span class="caret"></span></a>
<ul class="dropdown-menu">
<li><a href="../Linux安全扫描工具ClamAV安装及使用.txt/index.html">Linux安全扫描工具ClamAV安装及使用.txt</a></li>
<li><a href="../markmap-0.15.0/index.html">markmap-0.15.0</a></li>
<li><a href="../专家抽取系统/index.html">专家抽取系统</a></li>
<li><a href="../代理上网/index.html">代理上网</a></li>
<li><a href="../备忘录/index.html">备忘录</a></li>
<li><a href="../天喻教育统一认证登录.docx/index.html">天喻教育统一认证登录.docx</a></li>
<li><a href="../审核功能设计.txt/index.html">审核功能设计.txt</a></li>
<li><a href="../打通天喻平台机构人员数据.txt/index.html">打通天喻平台机构人员数据.txt</a></li>
<li><a href="../挂图作战/index.html">挂图作战</a></li>
<li><a href="../数据上报系统测试账号.txt/index.html">数据上报系统测试账号.txt</a></li>
<li><a href="../数据上报系统转发标志分析.txt/index.html">数据上报系统转发标志分析.txt</a></li>
<li><a href="../方法与技巧/index.html">方法与技巧</a></li>
<li><a href="../策略与办法/index.html">策略与办法</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<div class="book with-summary">
<div class="book-summary">
<div class="search-box form-group">
<input type="text" class="form-control" id="inputSearch" placeholder="搜索接口">
<span class="glyphicon glyphicon-search form-control-feedback" aria-hidden="true"></span>
</div>
<div id="accordion" class="catalog">
<div class="panel">
<div id="heading0" data-parent="#accordion" class="catalog-title" data-toggle="collapse"
aria-expanded="true" data-target="#collapse0" aria-controls="collapse0">
<i class="glyphicon glyphicon-align-justify"></i> DataShareController
</div>
<div id="collapse0" class="collapse in " aria-labelledby="heading0">
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#listSystem">
获取接入系统列表
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#addSystem">
增加一个数据共享系统
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#saveUploadFile">
功能上传系统的EXCEL文档
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#downloadXlsx">
功能下载EXCEL文档说明
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#getSystemById">
功能根据系统ID获取系统信息
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#delSystem">
功能:删除系统
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#updateSystem">
功能:修改系统名称
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#subscribe">
功能:指定的系统,它订阅哪些业务系统的数据表
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#changePwd">
功能:修改系统的密码
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#share">
功能:记录指定系统它有哪些数据表
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#getShareTable">
功能:获取指定系统它有哪些数据表
</a>
<a class="catalog-item" href="com_dsideal_QingLong_DataShare_Controller_DataShareController.html#getToken">
第三方接入系统获取执行票据Token
</a>
</div>
</div>
</div> </div>
<div class="book-body">
<div class="body-inner">
<div class="book-header">
<div class="d-flex justify-content-between">
<a class="header-menu toggle-catalog" href="javascript:void(0)"><i
class="glyphicon glyphicon-align-justify"></i> 目录</a>
</div>
</div>
<div class="page-wrapper">
<div class="page-inner">
<div class="action-list">
<div class="action-item">
<h2 id="listSystem"><a href="#">获取接入系统列表 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/listSystem</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>keyword</td>
<td>string</td>
<td></td>
<td>关键字</td>
</tr>
<tr>
<td>exclude</td>
<td>int</td>
<td></td>
<td>排除系统ID不显示在列表中0表示不排除其他表示排除</td>
</tr>
<tr>
<td>page</td>
<td>int</td>
<td></td>
<td>页码</td>
</tr>
<tr>
<td>limit</td>
<td>int</td>
<td></td>
<td>每页数量</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="addSystem"><a href="#">增加一个数据共享系统 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/addSystem</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>system_name</td>
<td>string</td>
<td></td>
<td>系统名称</td>
</tr>
<tr>
<td>user_name</td>
<td>string</td>
<td></td>
<td>访问账号</td>
</tr>
<tr>
<td>redirect_url</td>
<td>string</td>
<td></td>
<td>回调地址</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="saveUploadFile"><a href="#">功能上传系统的EXCEL文档 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/saveUploadFile</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="downloadXlsx"><a href="#">功能下载EXCEL文档说明 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/downloadXlsx</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>system_id</td>
<td>int</td>
<td></td>
<td>系统id</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="getSystemById"><a href="#">功能根据系统ID获取系统信息 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/getSystemById</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>system_id</td>
<td>int</td>
<td></td>
<td></td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="delSystem"><a href="#">功能:删除系统 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/delSystem</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>system_id</td>
<td>int</td>
<td></td>
<td></td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="updateSystem"><a href="#">功能:修改系统名称 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/updateSystem</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>system_id</td>
<td>int</td>
<td></td>
<td></td>
</tr>
<tr>
<td>system_name</td>
<td>string</td>
<td></td>
<td></td>
</tr>
<tr>
<td>redirect_url</td>
<td>string</td>
<td></td>
<td></td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="subscribe"><a href="#">功能:指定的系统,它订阅哪些业务系统的数据表 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/subscribe</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>system_id</td>
<td>int</td>
<td></td>
<td></td>
</tr>
<tr>
<td>subscribe_system_ids</td>
<td>string</td>
<td></td>
<td></td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="changePwd"><a href="#">功能:修改系统的密码 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/changePwd</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>system_id</td>
<td>int</td>
<td></td>
<td></td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="share"><a href="#">功能:记录指定系统它有哪些数据表 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/share</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>system_id</td>
<td>int</td>
<td></td>
<td></td>
</tr>
<tr>
<td>table_names</td>
<td>string</td>
<td></td>
<td></td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="getShareTable"><a href="#">功能:获取指定系统它有哪些数据表 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/getShareTable</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>system_id</td>
<td>int</td>
<td></td>
<td></td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="getToken"><a href="#">第三方接入系统获取执行票据Token </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/dataShare/getToken</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>user_name</td>
<td>string</td>
<td></td>
<td>分配给第三方的用户名</td>
</tr>
<tr>
<td>pwd</td>
<td>string</td>
<td></td>
<td>分配给第三方的密码</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.slim.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/js/bootstrap.min.js"></script>
<script src="https://cdn.jsdelivr.net/autocomplete.js/0/autocomplete.jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/google-code-prettify@1.0.5/bin/prettify.min.js"></script>
<script>
var search_source_data = [
{name: 'DataShareController.获取接入系统列表', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#listSystem'},
{name: 'DataShareController.增加一个数据共享系统', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#addSystem'},
{name: 'DataShareController.功能上传系统的EXCEL文档', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#saveUploadFile'},
{name: 'DataShareController.功能下载EXCEL文档说明', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#downloadXlsx'},
{name: 'DataShareController.功能根据系统ID获取系统信息', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#getSystemById'},
{name: 'DataShareController.功能:删除系统', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#delSystem'},
{name: 'DataShareController.功能:修改系统名称', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#updateSystem'},
{name: 'DataShareController.功能:指定的系统,它订阅哪些业务系统的数据表', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#subscribe'},
{name: 'DataShareController.功能:修改系统的密码', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#changePwd'},
{name: 'DataShareController.功能:记录指定系统它有哪些数据表', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#share'},
{name: 'DataShareController.功能:获取指定系统它有哪些数据表', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#getShareTable'},
{name: 'DataShareController.第三方接入系统获取执行票据Token', url: 'com_dsideal_QingLong_DataShare_Controller_DataShareController.html#getToken'},
];
$('.toggle-catalog').click(function () {
$('.book').toggleClass('with-summary');
});
$('#inputSearch').autocomplete({hint: false}, [
{
source: function (query, callback) {
var result = [];
for(var i = 0; i !== search_source_data.length; i++){
if(search_source_data[i].name.indexOf(query) !== -1){
result.push(search_source_data[i]);
}
}
callback(result);
},
displayKey: 'name',
templates: {
suggestion: function (suggestion) {
return suggestion.name;
}
}
}
]).on('autocomplete:selected', function (event, suggestion, dataset, context) {
self.location = suggestion.url;
});
</script>
</body>
</html>