feat:🚀 op api模块完成
This commit is contained in:
parent
c8c603e6f6
commit
dd4aea4129
|
@ -7,8 +7,8 @@ function(event, op) {
|
|||
```
|
||||
|
||||
### 参数
|
||||
* event
|
||||
class [FunctionEvent](./FunctionEvent.md)
|
||||
* event [FunctionEvent](./FunctionEvent.md)
|
||||
事件,函数上下文
|
||||
|
||||
* op
|
||||
class [Operation](./Operation.md)
|
||||
* op [Operation](./Operation.md)
|
||||
操作,函数操作
|
|
@ -1,9 +1,7 @@
|
|||
#### FunctionEvent
|
||||
|
||||
##### user
|
||||
class [User](./User.md)
|
||||
|
||||
|
||||
##### request
|
||||
class [Request](./Request.md)
|
||||
##### user [User](./User.md)
|
||||
用户
|
||||
|
||||
##### request [Request](./Request.md)
|
||||
请求
|
||||
|
|
|
@ -8,11 +8,15 @@
|
|||
|
||||
##### user [UserApi](./api/ModuleIdentity.md)
|
||||
用户模块接口
|
||||
|
||||
##### app [AppApi](./api/ModuleApplication.md)
|
||||
应用模块接口
|
||||
|
||||
##### permission [PermissionApi](./api/ModulePermission.md)
|
||||
权限模块接口
|
||||
|
||||
##### authentication [AuthenticationApi](./api/ModuleAuthentication.md)
|
||||
认证模块接口
|
||||
|
||||
##### organization [OrganizationApi](./api/ModuleOranization.md)
|
||||
组织模块接口
|
||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -1,3 +1,2 @@
|
|||
#### Authentication
|
||||
|
||||
TODO
|
||||
[toc]
|
|
@ -1 +1,768 @@
|
|||
#### OrganizationApi
|
||||
### UserApi
|
||||
[toc]
|
||||
#### create(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>username</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>用户名,唯一,不传后台自动生成</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>password</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>密码,不传后台生成默认密码</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>display_name</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>显示名称</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>firstname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>lastname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>姓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>realname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>真实姓名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pinyin</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>拼音</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nickname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>昵称</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>user_type</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>用户类型,不传后台设置系统默认类型</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mobile</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>手机</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>email</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>邮箱</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>gender</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>性别</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cert_type</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>证件类型</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cert_number</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>证件号</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>region</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>区域</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>work_time</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>加入时间</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>work_title</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>职位</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ext_prop</td>
|
||||
<td>json</td>
|
||||
<td>false</td>
|
||||
<td>扩展信息,json对象{"age": 18, "love": "足球"}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>status</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>状态:1正常,0禁用,后期扩展:离职、休假、借调。</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>password_status</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>密码状态(valid/invalid)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>idp_config_id</td>
|
||||
<td>number</td>
|
||||
<td>true</td>
|
||||
<td>身份源ID,作为创建时记录,不做更新</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### disable(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### enable(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### batchDisable(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>ids</td>
|
||||
<td>array</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### batchEnable(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>ids</td>
|
||||
<td>array</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### modify(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>username</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>用户名,验证唯一</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>password</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>密码</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>display_name</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>显示名称</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>firstname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>lastname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>姓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>realname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>真实姓名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pinyin</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>拼音</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nickname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>昵称</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mobile</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>手机</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>email</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>邮箱</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>gender</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>性别:1男,0女</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cert_type</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>证件类型</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cert_number</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>证件号</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>region</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>区域</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>work_time</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>加入时间</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>work_title</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>职位</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ext_prop</td>
|
||||
<td>json</td>
|
||||
<td>false</td>
|
||||
<td>扩展信息,json对象{"age": 18, "love": "足球"}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>last_login_ipaddr</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>上次登录IP</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>last_login_time</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>上次登录时间</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>status</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>状态,正常、禁用,后期扩展:离职、休假、借调。</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### delete(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### batchDelete(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>ids</td>
|
||||
<td>array</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### list(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<tr>
|
||||
<td>page_size</td>
|
||||
<td>integer</td>
|
||||
<td>false</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>page_num</td>
|
||||
<td>integer</td>
|
||||
<td>false</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>search_type</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>默认按用户字段搜索,当值为:generic时,全文检索</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>keyword</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>检索值</td>
|
||||
</tr>
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### get(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### modifyPassword(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>old_password</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>new_password</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### getStoredCredentials(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<tr>
|
||||
<td>user_id</td>
|
||||
<td>number</td>
|
||||
<td>false</td>
|
||||
<td>用户id标识</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>provider_code</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>社会化登录提供者的code</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>idp_config_id</td>
|
||||
<td>number</td>
|
||||
<td>false</td>
|
||||
<td>社会化登录配置的ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id1</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>社会化身份标识1,约定此字段保存用户唯一标识,如openid</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id2</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>社会化身份标识2,如unionid</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>metadata</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>更多社会化身份标识</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>status</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>状态</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>username</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>用户名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>display_name</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>显示名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>page_size</td>
|
||||
<td>integer</td>
|
||||
<td>false</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>page_num</td>
|
||||
<td>integer</td>
|
||||
<td>false</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### createStoreCredential(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>provider_code</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>社会化身份源code</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id1</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>社会化身份标识1,如openid</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id2</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>社会化身份标识2,如unionid</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>metadata</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>更多社会化身份标识</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>status</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>状态</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nickname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>昵称</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>avatar</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>头像</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id_provider_connection</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>idp_config_id</td>
|
||||
<td>number</td>
|
||||
<td>false</td>
|
||||
<td>社会化登录配置的ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>realname</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>真实姓名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mobile</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>手机</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>email</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>邮箱</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>gender</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>性别</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -0,0 +1,726 @@
|
|||
|
||||
### OrganizationApi
|
||||
[toc]
|
||||
|
||||
#### createOrganization(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### getNodeParent(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### deleteNode(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<tr>
|
||||
<td>object_code</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>树对象code</td>
|
||||
</tr>
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### getOrganizations(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### updateOrganization(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### getOrganization(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<tr>
|
||||
<td>code</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### deleteOrganization(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### addUserToNode(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>relation_data</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>关联扩展信息</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>relation_type</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>用于区分多重关联</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>is_default</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>1是,0否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>node_id</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>user_ids</td>
|
||||
<td>array</td>
|
||||
<td>false</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### updateMember(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td></td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>is_default</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>1是,0否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>action</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>移动节点move, 设置为默认关系as-default</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>source_node_id</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>移动前节点ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dest_node_id</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>移动后节点ID</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### getMembers(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<tr>
|
||||
<td>user_id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>用户ID</td>
|
||||
</tr>
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### getNodeMembers(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>node id</td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<tr>
|
||||
<td>relation_type</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>关联类型,用于区分多重关联</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>is_default</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>是否默认关系 1是,0否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>display_name</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>用户显示名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>username</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>用户名,支持模糊搜索(仅前缀)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mode</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>// mode - 低->高 bit
|
||||
// 第1位:是否获得指针节点所对应的真实结点,1-是,0-否
|
||||
// 第2位:是否展开WeakNode,即节点中类型不同的节点,1-展开,0-不展开
|
||||
// 第3位:是否递归地展开节点(不建议)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>page_num</td>
|
||||
<td>integer</td>
|
||||
<td>false</td>
|
||||
<td>起始页,默认1</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>page_size</td>
|
||||
<td>integer</td>
|
||||
<td>false</td>
|
||||
<td>页大小,默认10</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>page_sort</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>排序方式,格式:字段[排序方式]</td>
|
||||
</tr>
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### deleteNodeMembers(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>node_id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>node id</td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>ids</td>
|
||||
<td>array</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### deleteMember(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>用户节点ID</td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>ids</td>
|
||||
<td>array</td>
|
||||
<td>false</td>
|
||||
<td>用户与组织的关系ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>node_id</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>节点ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>user_id</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>用户原始ID</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### deleteMembers(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
<tr>
|
||||
<td>node_id</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>节点ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>user_id</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>用户原始ID</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### createNode(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### updateNode(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>更新树节点</td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### deleteChildrenNodes(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<tr>
|
||||
<td>object_code</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>树对象code</td>
|
||||
</tr>
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### getNodes(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<!-- query 参数 -->
|
||||
<tr>
|
||||
<td>object_code</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>创建树时的object_code</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>name</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>名字,支持前缀搜索</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>code</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>编号</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>tag</td>
|
||||
<td>string</td>
|
||||
<td>false</td>
|
||||
<td>标签</td>
|
||||
</tr>
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### getNode(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### getChildrenNodes(param)
|
||||
|
||||
|
||||
|
||||
##### param properties
|
||||
|
||||
<table class="param-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>名称</th>
|
||||
<th>类型</th>
|
||||
<th>是否必须</th>
|
||||
<th>描述</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<!-- path 参数 -->
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<!-- query 参数 -->
|
||||
<tr>
|
||||
<td>mode</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>// mode - 低->高 bit
|
||||
// 第1位:是否获得指针节点所对应的真实结点,1-是,0-否
|
||||
// 第2位:是否展开WeakNode,即节点中类型不同的节点,1-展开,0-不展开
|
||||
// 第3位:是否递归地展开节点(不建议)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object_code</td>
|
||||
<td>string</td>
|
||||
<td>true</td>
|
||||
<td>当id = 0时必填,创建树时的object_code</td>
|
||||
</tr>
|
||||
<!-- body 参数 -->
|
||||
</tbody>
|
||||
</table>
|
||||
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue