liuyafei
/
flow-doc-deleted
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
flow-doc-deleted/api/ModuleOranization.md

727 lines
18 KiB
Markdown
Raw Normal View History

feat::rocket: op api模块完成
2023-11-16 19:38:44 +08:00
### 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 - 低-&gt;高 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 - 低-&gt;高 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>