接口说明
<p>[TOC]</p>
<h1>接口形式</h1>
<ul>
<li>REST
<ul>
<li>api/archive/base/recieveData?token=abcd123……</li>
</ul></li>
<li>WebService
<ul>
<li>services/ArchiveService?wsdl</li>
</ul></li>
</ul>
<h1>请求方式</h1>
<p>POST
注意:REST请求URL中的token参数必须传入。请参照上一节的文档,获取E9生成的Token,并加入此参数。</p>
<h1>输入示例</h1>
<h2>JSON</h2>
<pre><code class="language-json">{
&quot;datas&quot;: [
{
&quot;arc&quot;: {
&quot;uniqueK&quot;: &quot;code&quot;,
&quot;uniqueV&quot;: &quot;2022110712345&quot;,
&quot;fondsCode&quot;: &quot;hll&quot;,
&quot;categoryCode&quot;: &quot;WSWJ&quot;,
&quot;element&quot;: [
{
&quot;name&quot;: &quot;code&quot;,
&quot;content&quot;: &quot;2022110712345&quot;
},
{
&quot;name&quot;: &quot;folder_title&quot;,
&quot;content&quot;: &quot;关于xx的函&quot;
},
{
&quot;name&quot;: &quot;year&quot;,
&quot;content&quot;: &quot;2021&quot;
},
{
&quot;name&quot;: &quot;file_date&quot;,
&quot;content&quot;: &quot;2021-08-15&quot;
}
]
},
&quot;files&quot;: [
{
&quot;document&quot;: [
{
&quot;needDownLoad&quot;: &quot;true&quot;,
&quot;ftpName&quot;: &quot;&quot;,
&quot;param&quot;: [
{
&quot;name&quot;: &quot;path&quot;,
&quot;content&quot;: &quot;http://10.10.10.10/doc/123.pdf&quot;
},
{
&quot;name&quot;: &quot;arc_document_name&quot;,
&quot;content&quot;: &quot;归档文件.pdf&quot;
}
]
}
],
&quot;metadata&quot;: {
&quot;type&quot;: &quot;12&quot;,
&quot;field&quot;: [
{
&quot;name&quot;: &quot;voucher_word&quot;,
&quot;content&quot;: &quot;2111&quot;
},
{
&quot;name&quot;: &quot;voucher_code&quot;,
&quot;content&quot;: &quot;32222&quot;
}
]
}
}
]
}
]
}</code></pre>
<h2>XML</h2>
<pre><code class="language-xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;datas&gt;
&lt;data&gt;
&lt;arc fondsCode=&quot;001&quot; categoryCode=&quot;KJPZ&quot; uniqueK=&quot;code&quot; uniqueV=&quot;2022110712345&quot; formBizId=&quot;&quot; &gt;
&lt;element name=&quot;set_code&quot;&gt;001&lt;/element&gt;
&lt;element name=&quot;code&quot;&gt;2022110712345&lt;/element&gt;
&lt;element name=&quot;file_date&quot;&gt;2022-11-01&lt;/element&gt;
&lt;element name=&quot;year&quot;&gt;2022&lt;/element&gt;
&lt;element name=&quot;month&quot;&gt;11&lt;/element&gt;
&lt;/arc&gt;
&lt;files&gt;
&lt;file&gt;
&lt;document needDownLoad=&quot;&quot; ftpName=&quot;&quot;&gt;
&lt;param name=&quot;path&quot;&gt;http://10.10.10.10/doc/123.pdf&lt;/param&gt;
&lt;param name=&quot;arc_document_name&quot;&gt;归档文件.pdf&lt;/param&gt;
&lt;/document&gt;
&lt;metadata type=&quot;3&quot;&gt;
&lt;field name=&quot;voucher_word&quot;&gt;2111&lt;/field&gt;
&lt;field name=&quot;voucher_code&quot;&gt;32222&lt;/field&gt;
&lt;!-- 元数据明细层,column的name属性为表字段名,可扩展 --&gt;
&lt;details&gt;
&lt;detail type=&quot;dt1&quot;&gt;
&lt;column name=&quot;abstract&quot;&gt;111&lt;/column&gt;
&lt;column name=&quot;subject&quot;&gt;555&lt;/column&gt;
&lt;/detail&gt;
&lt;/details&gt;
&lt;/metadata&gt;
&lt;/file&gt;
&lt;/files&gt;
&lt;/data&gt;
&lt;/datas&gt;</code></pre>
<h1>输入值说明</h1>
<p>报文节点层级结构说明:
</p>
<ul>
<li>
<p>datas:多条档案记录(条目)的字段值、附件(原文)、业务数据(元数据)的节点。可以包含多条档案信息的节点(data)。</p>
<ul>
<li>
<p>data:一条档案记录(条目)的字段值、附件(原文)、业务数据(元数据)的节点。</p>
</li>
<li>
<p>arc:档案记录(条目)节点。每个节点包含多个字段节点(element)。 属性如下:</p>
<p>—fondsCode:全宗号。档案系统中配置,由档案系统提供。(档案条目归档时:必填;元数据归档时:非必填)
—categoryCode:档案分类号。档案系统中配置,由档案系统提供。(档案条目归档时:必填;元数据归档时:非必填)
—uniqueK:档案系统数据表中存储的归档数据的【原始唯一字段名】。即源数据的id字段在档案系统数据表中的字段名。此字段用于判断重复、更新数据等使用。
—uniqueV:档案系统数据表中存储的归档数据的【原始唯一值】。即源数据的id在档案系统数据表中的值。此值用于判断重复、更新数据等使用。
—appId:业务系统id。如果只接收元数据和原文时,此项必填。此值在档案系统中注册【业务系统】后生成。</p>
</li>
<li>
<p>element:档案记录(条目)字段节点。 文本域为字段值。 属性如下:</p>
<p>—name:档案数据库字段英文名。必填。
—title:字段中文名。用于注释,不必填。</p>
</li>
<li>
<p>files:原文节点。可以包含多个原文信息(file节点)</p>
<ul>
<li>
<p>file:每一个原文的节点。每个节点包含一个原文的所有相关信息。</p>
</li>
<li>
<p>document:原文信息节点。每个节点包含一个原文的信息。 属性如下:</p>
<p>—needDownLoad:是否需要下载。必填。使用HTTP链接方式接收原文文件时,如果此项设置为true,则接口下载文件后,将文件上传到档案系统,形成档案副本文件;如果此项设置为false,则接口将文件的链接信息保存到系统中,通过HTTP链接方式直接访问原文文件。
—ftpName:系统中配置的ftp的名称。不必填。如果此处填写系统内部配置的ftp名称,则下方传输ftp路径时无需拼装用户名、密码,只需传入符合ftp协议的路径信息即可,接口自动连接ftp服务器,将文件下载后上传至档案系统中。</p>
<ul>
<li>param:原文表字段节点。 文本域为字段值。 属性如下:</li>
</ul>
<p>—name:档案数据库字段英文名。必填。
——name="path":文件所在路径信息。必填。可以是本地路径、HTTP链接、FTP链接。
———本地路径:local//d:/xx/xx.pdf 或 local//data/doc/xx.pdf
———HTTP链接:<a href="http://10.10.10.10/doc/xx.pdf">http://10.10.10.10/doc/xx.pdf</a>
———FTP链接:ftp://用户名:密码@10.10.10.10/doc/xx.pdf
——name="arc_document_name":文件显示名。必填。可以是任意文本。
—title:字段中文名。用于注释,不必填。</p>
</li>
<li>
<p>metadata:元数据主表节点。每个节点包含一条元数据信息。属性如下:</p>
<p>—type:元数据主表id。(档案 23.1115.00版本(含)以后支持直接写元数据表名) 必填。由档案系统提供。</p>
<ul>
<li>field:元数据字段节点。 文本域为字段值。 属性如下:</li>
</ul>
<p>—name:档案数据库字段英文名。必填。
—title:字段中文名。用于注释,不必填。</p>
<ul>
<li>
<p>details:元数据明细表节点。</p>
</li>
<li>
<p>detail:单个元数据明细表节点。 属性如下:</p>
<p>—type:元数据明细表的表名后缀,必填。一般为【dtN】,第一个明细表为【dt1】,第二个明细表为【dt2】,以此类推。</p>
<ul>
<li>column:元数据明细表字段节点。 文本域为字段值。 属性如下:</li>
</ul>
<p>—name:档案数据库字段英文名。必填。
—title:字段中文名。用于注释,不必填。</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h1>返回示例(JSON)</h1>
<h2>成功示例</h2>
<pre><code class="language-json">{
&quot;result&quot;: [
{
&quot;formBizId&quot;: &quot;59517000145&quot;,
&quot;messsage&quot;: &quot;&quot;,
&quot;status&quot;: true,
&quot;uniqueV&quot;: &quot;2dcbd2d3-d25e-4e91-8558-f0e0738adddb&quot;
}
],
&quot;runStatus&quot;: true
}</code></pre>
<h2>失败示例</h2>
<pre><code class="language-json">{
&quot;result&quot;: {
&quot;formBizId&quot;: &quot;&quot;,
&quot;messsage&quot;: &quot;元数据表不存在!&quot;,
&quot;status&quot;: false,
&quot;uniqueV&quot;: &quot;6c93f5aa-3f91-4bd6-b097-fa6bcc7f1a02&quot;
},
&quot;runStatus&quot;: false
}</code></pre>
<h1>返回值说明</h1>
<p>- runStatus:true/false,表示接口执行成功或者失败。</p>
<p>- result:返回结果
- formBizId:档案数据的formbizid(数据唯一值)。
- messsage:提示信息。
- status:true/false,表示接口执行成功或者失败。
- uniqueV:传入的数据原始ID值。</p>