trswcm6 5二次开发021服务说明

前言：本文档提供了对wcm6的一些服务调用说明文档，对应于应用地址webapps\wcm\WEB-INF\classes\trsconfig\service\wcm6文件下的服务配置文件。一个完整的服务调用包含四部分：服务名即服务ID、方法、参数、回调处理。我们在每一章的开头介绍了这一章服务的ID，方法名和参数会在小章节里介绍。由于服务调用方法一致，故没有ID：wcm6_website描述：保存站点是否save方法的参数，具体字段请参考《TRSWCM6.5数据字典》，这里不再一一列举。描述：返回值：无是否返回值：WebSites否是否附属权限否站点排序字段否SiteOrder站点显示名称否否否=否需要排除的否示例：返回值：WebSites对象是提取的字段列表否返回值：WebSite对象是提取的字段列表否描述：获取站点类型描述是是是否导出所有否是否导出所有否是待导入文件的否描述：类似创建一个站点返回值：Reports对象是描述：调整站点顺序返回值：无是是0示例：描述：获取回收站中的站点返回值：WebSites对象否站点排序字段否SiteOrder站点显示名称否否否=否否需要排除的否示例：描述：恢复回收站点中的站点返回值：无否需要恢复的站ID否恢复所有回收否SiteType参数说明：0为文字库、1为图片库、2为视频库、4为资源库说明：如果RestoreAll为false，必须传递参数ObjectIds是是是是否是示例：描述：清空站点回收站返回值：无否SiteType参数说明：0为文字库、1为图片库、2为视频库、4为资源库示例：需要排除的站是是是否否否否ObjectId0parentId、chnlNamechnlDesc，parentId0siteIdObjectId0，则表示保存已有的栏目。BasicDataHelper.call('wcm6_channel''save'parentId:0，},true,success,描述：返回值：无是否ID10,11,12BasicDataHelper.call('wcm6_channel','delete',{ObjectIds:'10,11,12',Drop:},true,success,返回值：Channels对象是否否BasicDataHelper.call('wcm6_channel','findByIds',ObjectIds:'10,11',},true,success,<ChannelsNum=<ChannelsNum="2"PageSize="20"PageCount="1"<ChannelHasChildren="false"<ChannelHasChildren="false"描述：获取单个栏目对象是否否BasicDataHelper.call('wcm6_channel','findById',ObjectId:10,},true,success,否否否息否否栏目排序字段及否栏目显示名称否否否=否需要排除的否返回值：如果导出成功返回导出后的文件名字符串，如果没有栏目返回否否否否否BasicDataHelper.call('wcm6_channel','export',ObjectIds:'10',},true,success,描述：将外部文件导入到系统中并生成栏目返回值：Reports对象必须符合WCM是否否否示例：id10BasicDataHelper.call('wcm6_channel','importChannels',ImportFile:DstChannelId:},true,success,返回值：Reports对象是否否注：类似创建操作是栏目导出、栏目导入两个操作的整合，参数中必须指定示例：id10BasicDataHelper.call('wcm6_channel','createFrom',SrcChannelId:DstChannelId:},true,success,描述：移动原始栏目到目标栏目或者目标站点下返回值：无是否否示例：是是0示例：描述：获取指定栏目的栏目回收站列表返回值：Channels对象否否否描述：恢复当前栏目下栏目回收站中的指定栏目返回值：无否否否否恢复的栏目ID序列ObjectId否是是描述：清空子栏目的回收站返回值：无否否回收站，若传入的是Channelid则清空一级子栏目的回收站否否是是描述：校验查询语句是否可执行返回值：sql语句(string)否否ID：wcm6_chnldoc描述：该类提供了关于栏目文档的一些操作服务，如改变文档的状态、复制文档、指定ChnlDoc是是//改变ID10，11，12的栏目文档状态为2BasicDataHelper.call('wcm6_chnldoc''changeStatus'ObjectIds:StatusId:},true//改变ID10，11，12的栏目文档状态为2BasicDataHelper.call('wcm6_chnldoc''changeStatus'ObjectIds:StatusId:},true,success,描述：批量复制不同栏目下的不同文档，即同时复制多篇文档返回值：Reports对象指定ID是ID列是BasicDataHelper.call('wcm6_chnldoc','copy',ObjectIds:ToChannelIds:},true,success,描述：批量引用栏目文档到多个栏目中返回值：Reports对象指定ID是目标栏目的是BasicDataHelper.call('wcm6_chnldoc','quote',ObjectIds:ToChannelIds:},true,success,描述：批量镜像引用栏目文档到不同的栏目中返回值：Reports对象指定ID是ID列是BasicDataHelper.call('wcm6_chnldoc','mirror',ObjectIds:ToChannelIds:},true,success,描述：批量删除栏目文档返回值：无指定ID是否ID10，11，12BasicDataHelper.call('wcm6_chnldoc','delete',Drop:true},true,success,指定ID是否否BasicDataHelper.call('wcm6_chnldoc','export',ObjectIds:},true,success,描述：批量移动栏目文档到指定的栏目中返回值：Reports对象指定ChnlDoc的ID是是BasicDataHelper.call('wcm6_chnldoc','move',},true,success,描述：批量发布栏目文档返回值：无指定ID是否8ID10，11，12BasicDataHelper.call('wcm6_chnldoc','publish',},true,success,检索的栏目否检索的站点否是否附属权限否是否递归检索否文档排序字段否查询的表串否返回的日期格式否MM-dd提取的字段列表否提取的文档字否作否否=否否否否否否否BasicDataHelper.call('wcm6_chnldoc','search',ChannelIds:'10',DocTitle:'%hello%'},true,success,ID：wcm6_document描述：该类主要提供了关于文档的保存，预览，查询，删除等操作，是对wcm文是否否trim的字否否否否trim的字否描述：删除文档返回值：无待删除的文档ID是否否否否否否型否否否作题否否=否间否间否描述：恢复回收站中选中的文档返回值：无否否待恢复的文档ID否是否恢复全部否描述：清空站点、栏目回收站点中的文档返回值：无否否描述：获取文档某一类型的附件返回值：Appendixes对象是是否描述：保存文档的附件返回值：无是是需要保存的附是指定的文档是是否否示例：描述：获取指定文档的扩展字段信息返回值：ContentExtendValues对象是排序字段及否否描述：将文档设置为置顶返回值：无文档所在栏目是设置置顶文档是是是否置顶相对于目否1描述：让文档根据配置的工作流开始流转返回值：无是示例：返回值：文档ViewDocument对象是否否ChnlDoc字否d提取的Document字否否}方法描述：批量改变文档的状态返回值：无指定ChnlDocRecId是是}方法描述：批量复制不同栏目下不同文档返回值：操作报告Reports对象指定ChnlDocRecId是是方法描述：批量引用不同栏目下不同文档返回值：操作报告Reports对象指定ChnlDocRecId是是方法描述：批量镜像不同栏目下不同文档返回值：操作报告Reports对象指定ChnlDocRecId是是方法描述：批量删除不同栏目下不同文档返回值：无指定ChnlDocdRecId是否}方法描述：批量导出不同栏目下不同文档返回值：导出文件的文件名String指定ChnlDocRecId否s否否否否否否}方法描述：批量移动不同栏目下不同文档到指定的栏目中返回值：操作报告Reports对象指定ChnlDocRecID是是}指定ChnlDocRecID是否1：增量发布，相当于服务的方法名为increasingPublish；2：完全发布，相当于服务的方法名为fullyPublish；3：单篇发布，相当于服务的方法名为basicPublish；5：更新发布，相当于服务的方法名为refreshPublish；7：撤销发布，相当于服务的方法名为recallPublish；返回值：文档集合ViewDocuments否否否0目否0式否否否否MM-dd否ChnlDoc提取的字否否否否否否否否否否e否否否=方法描述：获取废稿箱中的文档集合返回值：文档集合ViewDocuments对象否否否0目否0式否否否否MM-ddChnlDoc提取的字否否否=否否否否否否否否否e否否否=e},true);方法描述：批量预览不同栏目下不同文档返回值：字符串String指定ChnlDocRecID是/*/*预览ChnlDoc的RecId为7779的文档*/否否是详细介绍，有需要的话请参考《TRSWCM6.5数据字典》。',DocContent:'内容'方法描述：导入文档否否是否是否全部导入到当否是否忽略标题相同否是是文档排序字段及方式否否否否否否否否否e否否否否否否=方法描述：改变文档顺序返回值：无是需要改变顺序的文是是拖动相对于目标的(/之否1osition:1},true);方法描述：将文档设置为置顶返回值：无是是是置顶方式（取消/是否置顶相对于目标的(/之否1cumentId:16,TopFlag:2},true);否否'clearRecycle',{ChannelId:67},true);方法描述：获取文档隶属和引用信息返回值：字符串StringChnlDocRecID否否否ChnlDoc提取的字否r提取的文档字段列表否文档的排序字段及否null；如果不指定序列），找到文档的引用信息。方法描述：还原废稿箱中的文档返回值：无待恢复的RecId否否否否是是否是否否方法描述：获取指定文档的手工设定的相关文档返回值：相关文档Relations对象是否否EID：wcm6_template对象类型（站点栏目否目否否0描述：删除指定的模板返回值：无是是栏目是否否式否MM-dd否传查询的模否查询的模否查询的模否查询ID否=需要排除的模否返回值：Templates对象模板ID是获取的字段否返回值：Template对象是对象（站点否对象（站点栏目否获取的字段否返回值：无对象（站点/目是对象（站点/是描述：获取指定的模板的使用情况返回值：TemplateEmploys对象是否对象（站点/是对象（站点/目是否否否是否包含子对否否查询的模板名否查询的模板描否查询的模板创否查询的否=需要排除的模ID否描述：从指定的文件导入模板返回值：Reports对象对象（站点/是对象（站点/目是需要导入的文件是需要导入的文是否模板重名处理否1模板附件重名否1描述：校验选中的模板对象（站点/否对象（站点/目否否是否校验当前对象下所有的否是否校验子对否描述：校验指定的模板内容对象（站点/是对象（站点/目是否是描述：同步模板附件参数对象（站点/是对象（站点/目是否是否分发当前对象下的所有否对象（站点/是对象（站点/目是返回值：模板变量的ID(string)对象（站点/是对象（站点/目是是是否是描述：设置对象的默认模板返回值：无对象（站点/是对象（站点是是是描述：设置对象的其它概览模板返回值：无对象（站点/是对象（站点/是是是是是描述：分配模板到指定的栏目或站点返回值：无是否是否同时设置站点的模板关否描述：校验指定的内容否对象（站点/否对象（站点/目否否ID：wcm6_publish描述：该类提供了对发布设置及发布类型的相关操作服务，如获取发布设置、保是是否数Objecttype的默认值，我们只需传入对象ID即可。如下表所示：是是数Objecttype的默认值，我们只需传入对象ID即可。如下表所示：描述：发布指定的对象返回值：无是是否1描述：预览指定的对象的发布页面是是否预览文档时候否预览文档时候所在的栏目对否描述：获取撤销发布计划是是描述：设置对象的撤销发布计划返回值：无是是是否提 描述：保存在指定视图下提交的数据信息返回值：MetaViewData对象要保存的元数是否否描述：获取指定的视图数据传否否排序字段用否返回的日期否ChnlDoc提取的字段列否返回值：MetaViewDate对象是否否返回的日期格式否描述：导出元数据否否是描述：导出指定视图或栏目下的所有元数据记录否否描述：批量复制记录到目标栏目返回值：Reports对象是列是描述：在指定的栏目下导入指定的视图返回值：Reports对象是是需要导入的文件是否描述：将分类法中的记录移动到另一个分类法下返回值：无列是列是是描述：将记录复制到另一个分类法中返回值：无列是目标分类法是ID：wcm6_MetaDataDef描述：检索元数据相关字段信息返回值：MetaDBFields对象式否传元数否元数否字段否=分类否=查询否描述：获取元数据结构信息排序字段及否元数据别串否名元数据名否元数据描述否元数否=查询创建否式否传视图串否视图串否视图否=查询否描述：查询视图字段信息式否FieldOrder否否传视图否视图否视图字段否=分类否=查询否描述：保存元数据表信息是否否否描述：删除元数据表信息是ID序是描述：删除视图ID是描述：删除视图字段是是否否否否否否否否否否否描述：保存视图信息是否否否否描述：保存视图字段信息是否否否否否段否段否否否否否否否否否返回值：MetaView对象是返回值：MetaViewField对象是返回值：MetaDBField对象是描述：从XML文件创建视图返回值：MetaView对象否据是描述：改变视图字段顺序是是否描述：维护视图字段：目前仅仅适用单表模式返回值：无是ID是描述：设置视图字段的属性返回值：无ID是是是IDID返回值：MetaView对象是描述：给指定的栏目分配视图是是描述：获取指定栏目的视图是描述：产生视图的应用否是否描述：保存文档的同步规则返回值：无是否否描述：查询文档的同步规则是描述：重新产生元数据表的相关信息返回值：无是描述：获取使用了分类法的视图否描述：获取使用了视图的分类法否描述：按照文本文件的定义，创建整个系统是名是是否否否码否否描述：从xml文件导入视图是ID：wcm6_ClassInfo描述：该类提供了对分类法的一些常用操作服务，例如保存分类法、获取指定的是否同级分类法中的前一个分类否否否BasicDataHelper.call('wcm6_ClassInfo',BasicDataHelper.call('wcm6_ClassInfo','saveClassInfo',ObjectId:0,},true,success,描述：获取指定的分类法返回值：ClassInfos对象否0否否ClassOrder否否否=否BasicDataHelper.call('wcm6_ClassInfo''queryClassInfos'},true,success,描述：根据多个父分类法构造分类法树是分类法树产生的否0整数否0注：type表示分类法产生的方式，type=0表示沿着一条链一直展开，用于定位到一个IDS有父子关系;type!=0IDS序列，用于定id。SelectType0，1，SelectType=0表示可以选择树的每一个节点;SelectType=1表示仅能选择树的叶子节点。描述：根据一个分类法构造分类法树否0整数否0描述：删除某个分类法或者多个分类法返回值：无待删除的分类否待删除的分类ID否示例：返回值：ClassInfo对象是是ID13ID13BasicDataHelper.call('wcm6_ClassInfo','getPath',{},true,success,返回值：如果存在则返回ClassInfo对象，否则返回否是否=描述：从外部导入分类法待导入的文件名是否0是否包含分类否否描述：改变顺序是否是是否ID：wcm6_auth是ID10ID10BasicDataHelper.call('wcm6_auth','deleteOperatorRight',{ObjectId:10},true,success,是是是,},true,success,该示例表示当前登录用户给ID为3的角色（wcm对象类型为203ObjTYPE><ObjID>1</ObjID>）的权限，权限值为1000000000000001000000010ID：wcm6_infoview是是提交人的用户名否表单文档正文是JSPRequestProcessorprocessor=newJSPRequestProcessor(request,StringsServiceId="wcm6_infoview",sMethodName=HashMapparameters=newparameters.put("channelid","10");部新建一个表单文档，查看数据库WCMDOCUMENT中新添加的这条表单文档记录，查看其字段DOCCONTENT中的值，自己构造的xml结构与字段DOCCONTENT中的内容一致。例如：<?xmlversion="1.0"encoding="UTF-8"?><my:myFieldsStringsXmlContent="";StringsResult=(String)processor.excute(sServiceId,sMethodName,示例：采用DataExchangeStringsServiceId=StringsMethodName=MapoPostData=newHashMap();oPostData.put("channelid","10");/*xml字符串，xmlWCM系统内部新建一个的值，自己构造的xml结构与字段DOCCONTENT中的内容基本一致。但是需要特别说明：由于<?xmlversion="1.0"encoding="UTF-8"?><my:myFields<?xmlversion="1.0"encoding="UTF-8"?><my:myFields<?xmlversion="1.0"encoding="UTF-8"?><my:myFields号StringsXmlContent="";DispatchoDispatch=WCMServiceCaller.Call(sServiceId,sMethodName,oPostData,false);是为已发，2为未发是检索返回哪些字段的信息（可以添加表单的一些字段，例如ivfield1,ivfield2否key="/my:myFields/my:性别"value="男"/><SearchItemkey="/my:myFields/my:学历"value="本科"/></SearchXML>每一个检索字段为一个SearchItem否//使用DataExchange的方式参数的设置StringsServiceIdwcm6_infoview";StringsMethodName="queryData";MapoPostData=newHashMap();oPostData.put("DocStatusMode","0");别"value="男"/><SearchItemkey="/my:myFields/my:学历"value="本科"/></SearchXML>，每一个检索字段是一个SearchItem节点StringsSearchXml="";DispatchoDispatch=WCMServiceCaller.Call(sServiceId,sMethodName,oPostData,false);<dataset><dataheader><fieldname="FLOWOPERATIONMARK"desc="状态"/><fieldname="DOCIDdesc="文档编号"/><fieldname="DOCTITLE"desc="文档标题"/><fieldname="CRTIME"desc="创建时间"/><fieldname="DOCSTATUS"态态js调用服务，可以在HTML<script使用DataExchange工具调用服务，首先要按照内网中的文档了解DataExchange，/portal/portaldoc/documentshow.jsp?ChannelI