E9文书定接口说明

E9档案对外接口


接口说明

<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">{   &amp;quot;datas&amp;quot;: [     {       &amp;quot;arc&amp;quot;: {         &amp;quot;uniqueK&amp;quot;: &amp;quot;code&amp;quot;,         &amp;quot;uniqueV&amp;quot;: &amp;quot;2022110712345&amp;quot;,         &amp;quot;fondsCode&amp;quot;: &amp;quot;hll&amp;quot;,         &amp;quot;categoryCode&amp;quot;: &amp;quot;WSWJ&amp;quot;,         &amp;quot;element&amp;quot;: [           {             &amp;quot;name&amp;quot;: &amp;quot;code&amp;quot;,             &amp;quot;content&amp;quot;: &amp;quot;2022110712345&amp;quot;           },           {             &amp;quot;name&amp;quot;: &amp;quot;folder_title&amp;quot;,             &amp;quot;content&amp;quot;: &amp;quot;关于xx的函&amp;quot;           },           {             &amp;quot;name&amp;quot;: &amp;quot;year&amp;quot;,             &amp;quot;content&amp;quot;: &amp;quot;2021&amp;quot;           },           {             &amp;quot;name&amp;quot;: &amp;quot;file_date&amp;quot;,             &amp;quot;content&amp;quot;: &amp;quot;2021-08-15&amp;quot;           }         ]       },       &amp;quot;files&amp;quot;: [         {           &amp;quot;document&amp;quot;: [             {               &amp;quot;needDownLoad&amp;quot;: &amp;quot;true&amp;quot;,               &amp;quot;ftpName&amp;quot;: &amp;quot;&amp;quot;,               &amp;quot;param&amp;quot;: [                 {                   &amp;quot;name&amp;quot;: &amp;quot;path&amp;quot;,                   &amp;quot;content&amp;quot;: &amp;quot;http://10.10.10.10/doc/123.pdf&amp;quot;                 },                 {                   &amp;quot;name&amp;quot;: &amp;quot;arc_document_name&amp;quot;,                   &amp;quot;content&amp;quot;: &amp;quot;归档文件.pdf&amp;quot;                 }               ]             }           ],           &amp;quot;metadata&amp;quot;: {             &amp;quot;type&amp;quot;: &amp;quot;12&amp;quot;,             &amp;quot;field&amp;quot;: [               {                 &amp;quot;name&amp;quot;: &amp;quot;voucher_word&amp;quot;,                 &amp;quot;content&amp;quot;: &amp;quot;2111&amp;quot;               },               {                 &amp;quot;name&amp;quot;: &amp;quot;voucher_code&amp;quot;,                 &amp;quot;content&amp;quot;: &amp;quot;32222&amp;quot;               }             ]           }         }       ]     }   ] }</code></pre> <h2>XML</h2> <pre><code class="language-xml">&amp;lt;?xml version=&amp;quot;1.0&amp;quot; encoding=&amp;quot;UTF-8&amp;quot;?&amp;gt; &amp;lt;datas&amp;gt;     &amp;lt;data&amp;gt;         &amp;lt;arc fondsCode=&amp;quot;001&amp;quot; categoryCode=&amp;quot;KJPZ&amp;quot; uniqueK=&amp;quot;code&amp;quot; uniqueV=&amp;quot;2022110712345&amp;quot; formBizId=&amp;quot;&amp;quot; &amp;gt;             &amp;lt;element name=&amp;quot;set_code&amp;quot;&amp;gt;001&amp;lt;/element&amp;gt;             &amp;lt;element name=&amp;quot;code&amp;quot;&amp;gt;2022110712345&amp;lt;/element&amp;gt;             &amp;lt;element name=&amp;quot;file_date&amp;quot;&amp;gt;2022-11-01&amp;lt;/element&amp;gt;             &amp;lt;element name=&amp;quot;year&amp;quot;&amp;gt;2022&amp;lt;/element&amp;gt;             &amp;lt;element name=&amp;quot;month&amp;quot;&amp;gt;11&amp;lt;/element&amp;gt;         &amp;lt;/arc&amp;gt;         &amp;lt;files&amp;gt;             &amp;lt;file&amp;gt;                 &amp;lt;document needDownLoad=&amp;quot;&amp;quot; ftpName=&amp;quot;&amp;quot;&amp;gt;                     &amp;lt;param name=&amp;quot;path&amp;quot;&amp;gt;http://10.10.10.10/doc/123.pdf&amp;lt;/param&amp;gt;                     &amp;lt;param name=&amp;quot;arc_document_name&amp;quot;&amp;gt;归档文件.pdf&amp;lt;/param&amp;gt;                 &amp;lt;/document&amp;gt;                 &amp;lt;metadata type=&amp;quot;3&amp;quot;&amp;gt;                     &amp;lt;field name=&amp;quot;voucher_word&amp;quot;&amp;gt;2111&amp;lt;/field&amp;gt;                     &amp;lt;field name=&amp;quot;voucher_code&amp;quot;&amp;gt;32222&amp;lt;/field&amp;gt;                     &amp;lt;!-- 元数据明细层,column的name属性为表字段名,可扩展 --&amp;gt;                     &amp;lt;details&amp;gt;                         &amp;lt;detail type=&amp;quot;dt1&amp;quot;&amp;gt;                             &amp;lt;column name=&amp;quot;abstract&amp;quot;&amp;gt;111&amp;lt;/column&amp;gt;                             &amp;lt;column name=&amp;quot;subject&amp;quot;&amp;gt;555&amp;lt;/column&amp;gt;                         &amp;lt;/detail&amp;gt;                     &amp;lt;/details&amp;gt;                 &amp;lt;/metadata&amp;gt;             &amp;lt;/file&amp;gt;         &amp;lt;/files&amp;gt;     &amp;lt;/data&amp;gt; &amp;lt;/datas&amp;gt;</code></pre> <h1>输入值说明</h1> <p>报文节点层级结构说明: ![报文节点层级结构](<a href="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=137f805cf1db36965bf6d5670ad6615f&amp;file=file.png">https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=137f805cf1db36965bf6d5670ad6615f&amp;file=file.png</a> &quot;报文节点层级结构&quot;)</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=&quot;path&quot;:文件所在路径信息。必填。可以是本地路径、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=&quot;arc_document_name&quot;:文件显示名。必填。可以是任意文本。 —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">{ &amp;quot;result&amp;quot;: [ { &amp;quot;formBizId&amp;quot;: &amp;quot;59517000145&amp;quot;, &amp;quot;messsage&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;status&amp;quot;: true, &amp;quot;uniqueV&amp;quot;: &amp;quot;2dcbd2d3-d25e-4e91-8558-f0e0738adddb&amp;quot; } ], &amp;quot;runStatus&amp;quot;: true }</code></pre> <h2>失败示例</h2> <pre><code class="language-json">{ &amp;quot;result&amp;quot;: { &amp;quot;formBizId&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;messsage&amp;quot;: &amp;quot;元数据表不存在!&amp;quot;, &amp;quot;status&amp;quot;: false, &amp;quot;uniqueV&amp;quot;: &amp;quot;6c93f5aa-3f91-4bd6-b097-fa6bcc7f1a02&amp;quot; }, &amp;quot;runStatus&amp;quot;: false }</code></pre> <h1>返回值说明</h1> <p>-  runStatus:true/false,表示接口执行成功或者失败。</p> <p>-  result:返回结果 -  formBizId:档案数据的formbizid(数据唯一值)。 -  messsage:提示信息。 -  status:true/false,表示接口执行成功或者失败。 -  uniqueV:传入的数据原始ID值。</p>

页面列表

ITEM_HTML