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

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


全量同步部门

<p><strong>简要描述:</strong> </p> <ul> <li>全量同步部门,首次完整的部门上下级关系需要一次性同步(<strong>慎用,会重置整个部门关系</strong>)</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>{Host}/v2/department/syncAllDepartments</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST (application/json) </li> </ul> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">departments</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Department[]</td> <td>部门信息集合</td> </tr> </tbody> </table> <p>Department 实体:</p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">corpDepartmentId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>第三方部门Id</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>部门名称</td> </tr> <tr> <td style="text-align: left;">parentId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>父部门Id</td> </tr> <tr> <td style="text-align: left;">order</td> <td style="text-align: left;">否</td> <td style="text-align: left;">long</td> <td>排序</td> </tr> </tbody> </table> <p><strong>提交数据示例</strong></p> <pre><code>{ &amp;quot;departments&amp;quot;: [ { &amp;quot;corpDepartmentId&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;parentId&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;order&amp;quot;: 0 } ], &amp;quot;appKey&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;sign&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;timestamp&amp;quot;: 0, &amp;quot;projectId&amp;quot;: &amp;quot;string&amp;quot; }</code></pre> <p><strong>返回数据说明</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">int</td> <td>错误码</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">string</td> <td>错误描述,成功为空</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">DepartmentRelation[]</td> <td>部门关系集合</td> </tr> </tbody> </table> <p>DepartmentRelation 实体:</p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">corpDepartmentId</td> <td style="text-align: left;">string</td> <td>第三方部门Id</td> </tr> <tr> <td style="text-align: left;">projectId</td> <td style="text-align: left;">string</td> <td>明道云组织编号</td> </tr> <tr> <td style="text-align: left;">departmentId</td> <td style="text-align: left;">string</td> <td>明道云部门Id</td> </tr> </tbody> </table> <p><strong>成功</strong></p> <pre><code>{ &amp;quot;data&amp;quot;: [ { &amp;quot;corpDepartmentId&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;projectId&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;departmentId&amp;quot;: &amp;quot;string&amp;quot; } ], &amp;quot;code&amp;quot;: 1, &amp;quot;message&amp;quot;: &amp;quot;&amp;quot; }</code></pre> <p><strong>失败</strong></p> <pre><code>{ &amp;quot;code&amp;quot;: 10001, &amp;quot;message&amp;quot;: &amp;quot;错误描述&amp;quot; }</code></pre>

页面列表

ITEM_HTML