检出文档
<p>[TOC]</p>
<h4>请求</h4>
<h5>请求命令 CadCommand</h5>
<ul>
<li><code>CheckOutDocument 2</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li><code>IPCClient.Instance.PostMessage</code></li>
</ul>
<h5>请求参数说明</h5>
<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;">dataModel</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">doc_object</td>
<td>待检出文档对象</td>
</tr>
</tbody>
</table>
<p><strong>doc_object 参数</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;">rootFileName</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>CAD根文档名称</td>
</tr>
<tr>
<td style="text-align: left;">files</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">array[file_object]</td>
<td>待检出的文档列表</td>
</tr>
</tbody>
</table>
<p><strong>file_object 参数</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;">cadId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>插件自行生成的Guid，客户端响应结果中，也会携带该Id，以便数据进行唯一匹配</td>
</tr>
<tr>
<td style="text-align: left;">fileName</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>CAD文档名称</td>
</tr>
</tbody>
</table>
<h5>完整请求示例</h5>
<pre><code>{
&quot;dataModel&quot;: {
&quot;rootFileName&quot;: &quot;根装配件.SLDASM&quot;,
&quot;files&quot;: [
{
&quot;cadId&quot;: &quot;ca3cc2f9-82c9-4324-97f3-795027510f86&quot;,
&quot;fileName&quot;: &quot;子零件.SLDPRT&quot;
}
]
},
&quot;abstractCadType&quot;: &quot;_3d&quot;,
&quot;cadType&quot;: &quot;solidworks&quot;,
&quot;cadCommand&quot;: 2,
&quot;msgSendWay&quot;: 0
}</code></pre>
<h4>响应</h4>
<h5>返回示例</h5>
<pre><code>{
&quot;data&quot;: {
&quot;dataModel&quot;: [
{
&quot;success&quot;: false,
&quot;checkoutor&quot;: &quot;&quot;,
&quot;message&quot;: &quot;已被IERP1检出，不允许执行此操作&quot;,
&quot;cadId&quot;: &quot;ca3cc2f9-82c9-4324-97f3-795027510f86&quot;,
&quot;fileName&quot;: &quot;子零件.SLDPRT&quot;
}
],
&quot;abstractCadType&quot;: &quot;_3d&quot;,
&quot;cadType&quot;: &quot;solidworks&quot;,
&quot;cadCommand&quot;: 2,
&quot;msgSendWay&quot;: 0
},
&quot;success&quot;: true,
&quot;message&quot;: null,
&quot;errCode&quot;: null
}</code></pre>
<h5>返回参数说明</h5>
<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;">dataModel</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">array[result_object]</td>
<td>检出结果的集合</td>
</tr>
</tbody>
</table>
<p><strong>result_object 参数</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;">success</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">bool</td>
<td>是否检出成功</td>
</tr>
<tr>
<td style="text-align: left;">checkoutor</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>检出人</td>
</tr>
<tr>
<td style="text-align: left;">message</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>提醒消息</td>
</tr>
<tr>
<td style="text-align: left;">cadId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>请求时携带的Guid</td>
</tr>
<tr>
<td style="text-align: left;">fileName</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>文档名称</td>
</tr>
</tbody>
</table>