trswcm6 5二次開(kāi)發(fā)021服務(wù)說(shuō)明

前言：本文檔提供了對(duì)wcm6的一些服務(wù)調(diào)用說(shuō)明文檔，對(duì)應(yīng)于應(yīng)用地址webapps\wcm\WEB-INF\classes\trsconfig\service\wcm6文件下的服務(wù)配置文件。一個(gè)完整的服務(wù)調(diào)用包含四部分：服務(wù)名即服務(wù)ID、方法、參數(shù)、回調(diào)處理。我們?cè)诿恳徽碌拈_(kāi)頭介紹了這一章服務(wù)的ID，方法名和參數(shù)會(huì)在小章節(jié)里介紹。由于服務(wù)調(diào)用方法一致，故沒(méi)有ID：wcm6_website描述：保存站點(diǎn)是否save方法的參數(shù)，具體字段請(qǐng)參考《TRSWCM6.5數(shù)據(jù)字典》，這里不再一一列舉。描述：返回值：無(wú)是否返回值：WebSites否是否附屬權(quán)限否站點(diǎn)排序字段否SiteOrder站點(diǎn)顯示名稱否否否=否需要排除的否示例：返回值：WebSites對(duì)象是提取的字段列表否返回值：WebSite對(duì)象是提取的字段列表否描述：獲取站點(diǎn)類型描述是是是否導(dǎo)出所有否是否導(dǎo)出所有否是待導(dǎo)入文件的否描述：類似創(chuàng)建一個(gè)站點(diǎn)返回值：Reports對(duì)象是描述：調(diào)整站點(diǎn)順序返回值：無(wú)是是0示例：描述：獲取回收站中的站點(diǎn)返回值：WebSites對(duì)象否站點(diǎn)排序字段否SiteOrder站點(diǎn)顯示名稱否否否=否否需要排除的否示例：描述：恢復(fù)回收站點(diǎn)中的站點(diǎn)返回值：無(wú)否需要恢復(fù)的站ID否恢復(fù)所有回收否SiteType參數(shù)說(shuō)明：0為文字庫(kù)、1為圖片庫(kù)、2為視頻庫(kù)、4為資源庫(kù)說(shuō)明：如果RestoreAll為false，必須傳遞參數(shù)ObjectIds是是是是否是示例：描述：清空站點(diǎn)回收站返回值：無(wú)否SiteType參數(shù)說(shuō)明：0為文字庫(kù)、1為圖片庫(kù)、2為視頻庫(kù)、4為資源庫(kù)示例：需要排除的站是是是否否否否ObjectId0parentId、chnlNamechnlDesc，parentId0siteIdObjectId0，則表示保存已有的欄目。BasicDataHelper.call('wcm6_channel''save'parentId:0，},true,success,描述：返回值：無(wú)是否ID10,11,12BasicDataHelper.call('wcm6_channel','delete',{ObjectIds:'10,11,12',Drop:},true,success,返回值：Channels對(duì)象是否否BasicDataHelper.call('wcm6_channel','findByIds',ObjectIds:'10,11',},true,success,<ChannelsNum=<ChannelsNum="2"PageSize="20"PageCount="1"<ChannelHasChildren="false"<ChannelHasChildren="false"描述：獲取單個(gè)欄目對(duì)象是否否BasicDataHelper.call('wcm6_channel','findById',ObjectId:10,},true,success,否否否息否否欄目排序字段及否欄目顯示名稱否否否=否需要排除的否返回值：如果導(dǎo)出成功返回導(dǎo)出后的文件名字符串，如果沒(méi)有欄目返回否否否否否BasicDataHelper.call('wcm6_channel','export',ObjectIds:'10',},true,success,描述：將外部文件導(dǎo)入到系統(tǒng)中并生成欄目返回值：Reports對(duì)象必須符合WCM是否否否示例：id10BasicDataHelper.call('wcm6_channel','importChannels',ImportFile:DstChannelId:},true,success,返回值：Reports對(duì)象是否否注：類似創(chuàng)建操作是欄目導(dǎo)出、欄目導(dǎo)入兩個(gè)操作的整合，參數(shù)中必須指定示例：id10BasicDataHelper.call('wcm6_channel','createFrom',SrcChannelId:DstChannelId:},true,success,描述：移動(dòng)原始欄目到目標(biāo)欄目或者目標(biāo)站點(diǎn)下返回值：無(wú)是否否示例：是是0示例：描述：獲取指定欄目的欄目回收站列表返回值：Channels對(duì)象否否否描述：恢復(fù)當(dāng)前欄目下欄目回收站中的指定欄目返回值：無(wú)否否否否恢復(fù)的欄目ID序列ObjectId否是是描述：清空子欄目的回收站返回值：無(wú)否否回收站，若傳入的是Channelid則清空一級(jí)子欄目的回收站否否是是描述：校驗(yàn)查詢語(yǔ)句是否可執(zhí)行返回值：sql語(yǔ)句(string)否否ID：wcm6_chnldoc描述：該類提供了關(guān)于欄目文檔的一些操作服務(wù)，如改變文檔的狀態(tài)、復(fù)制文檔、指定ChnlDoc是是//改變ID10，11，12的欄目文檔狀態(tài)為2BasicDataHelper.call('wcm6_chnldoc''changeStatus'ObjectIds:StatusId:},true//改變ID10，11，12的欄目文檔狀態(tài)為2BasicDataHelper.call('wcm6_chnldoc''changeStatus'ObjectIds:StatusId:},true,success,描述：批量復(fù)制不同欄目下的不同文檔，即同時(shí)復(fù)制多篇文檔返回值：Reports對(duì)象指定ID是ID列是BasicDataHelper.call('wcm6_chnldoc','copy',ObjectIds:ToChannelIds:},true,success,描述：批量引用欄目文檔到多個(gè)欄目中返回值：Reports對(duì)象指定ID是目標(biāo)欄目的是BasicDataHelper.call('wcm6_chnldoc','quote',ObjectIds:ToChannelIds:},true,success,描述：批量鏡像引用欄目文檔到不同的欄目中返回值：Reports對(duì)象指定ID是ID列是BasicDataHelper.call('wcm6_chnldoc','mirror',ObjectIds:ToChannelIds:},true,success,描述：批量刪除欄目文檔返回值：無(wú)指定ID是否ID10，11，12BasicDataHelper.call('wcm6_chnldoc','delete',Drop:true},true,success,指定ID是否否BasicDataHelper.call('wcm6_chnldoc','export',ObjectIds:},true,success,描述：批量移動(dòng)欄目文檔到指定的欄目中返回值：Reports對(duì)象指定ChnlDoc的ID是是BasicDataHelper.call('wcm6_chnldoc','move',},true,success,描述：批量發(fā)布欄目文檔返回值：無(wú)指定ID是否8ID10，11，12BasicDataHelper.call('wcm6_chnldoc','publish',},true,success,檢索的欄目否檢索的站點(diǎn)否是否附屬權(quán)限否是否遞歸檢索否文檔排序字段否查詢的表串否返回的日期格式否MM-dd提取的字段列表否提取的文檔字否作否否=否否否否否否否BasicDataHelper.call('wcm6_chnldoc','search',ChannelIds:'10',DocTitle:'%hello%'},true,success,ID：wcm6_document描述：該類主要提供了關(guān)于文檔的保存，預(yù)覽，查詢，刪除等操作，是對(duì)wcm文是否否trim的字否否否否trim的字否描述：刪除文檔返回值：無(wú)待刪除的文檔ID是否否否否否否型否否否作題否否=否間否間否描述：恢復(fù)回收站中選中的文檔返回值：無(wú)否否待恢復(fù)的文檔ID否是否恢復(fù)全部否描述：清空站點(diǎn)、欄目回收站點(diǎn)中的文檔返回值：無(wú)否否描述：獲取文檔某一類型的附件返回值：Appendixes對(duì)象是是否描述：保存文檔的附件返回值：無(wú)是是需要保存的附是指定的文檔是是否否示例：描述：獲取指定文檔的擴(kuò)展字段信息返回值：ContentExtendValues對(duì)象是排序字段及否否描述：將文檔設(shè)置為置頂返回值：無(wú)文檔所在欄目是設(shè)置置頂文檔是是是否置頂相對(duì)于目否1描述：讓文檔根據(jù)配置的工作流開(kāi)始流轉(zhuǎn)返回值：無(wú)是示例：返回值：文檔ViewDocument對(duì)象是否否ChnlDoc字否d提取的Document字否否}方法描述：批量改變文檔的狀態(tài)返回值：無(wú)指定ChnlDocRecId是是}方法描述：批量復(fù)制不同欄目下不同文檔返回值：操作報(bào)告Reports對(duì)象指定ChnlDocRecId是是方法描述：批量引用不同欄目下不同文檔返回值：操作報(bào)告Reports對(duì)象指定ChnlDocRecId是是方法描述：批量鏡像不同欄目下不同文檔返回值：操作報(bào)告Reports對(duì)象指定ChnlDocRecId是是方法描述：批量刪除不同欄目下不同文檔返回值：無(wú)指定ChnlDocdRecId是否}方法描述：批量導(dǎo)出不同欄目下不同文檔返回值：導(dǎo)出文件的文件名String指定ChnlDocRecId否s否否否否否否}方法描述：批量移動(dòng)不同欄目下不同文檔到指定的欄目中返回值：操作報(bào)告Reports對(duì)象指定ChnlDocRecID是是}指定ChnlDocRecID是否1：增量發(fā)布，相當(dāng)于服務(wù)的方法名為increasingPublish；2：完全發(fā)布，相當(dāng)于服務(wù)的方法名為fullyPublish；3：?jiǎn)纹l(fā)布，相當(dāng)于服務(wù)的方法名為basicPublish；5：更新發(fā)布，相當(dāng)于服務(wù)的方法名為refreshPublish；7：撤銷發(fā)布，相當(dāng)于服務(wù)的方法名為recallPublish；返回值：文檔集合ViewDocuments否否否0目否0式否否否否MM-dd否ChnlDoc提取的字否否否否否否否否否否e否否否=方法描述：獲取廢稿箱中的文檔集合返回值：文檔集合ViewDocuments對(duì)象否否否0目否0式否否否否MM-ddChnlDoc提取的字否否否=否否否否否否否否否e否否否=e},true);方法描述：批量預(yù)覽不同欄目下不同文檔返回值：字符串String指定ChnlDocRecID是/*/*預(yù)覽ChnlDoc的RecId為7779的文檔*/否否是詳細(xì)介紹，有需要的話請(qǐng)參考《TRSWCM6.5數(shù)據(jù)字典》。',DocContent:'內(nèi)容'方法描述：導(dǎo)入文檔否否是否是否全部導(dǎo)入到當(dāng)否是否忽略標(biāo)題相同否是是文檔排序字段及方式否否否否否否否否否e否否否否否否=方法描述：改變文檔順序返回值：無(wú)是需要改變順序的文是是拖動(dòng)相對(duì)于目標(biāo)的(/之否1osition:1},true);方法描述：將文檔設(shè)置為置頂返回值：無(wú)是是是置頂方式（取消/是否置頂相對(duì)于目標(biāo)的(/之否1cumentId:16,TopFlag:2},true);否否'clearRecycle',{ChannelId:67},true);方法描述：獲取文檔隸屬和引用信息返回值：字符串StringChnlDocRecID否否否ChnlDoc提取的字否r提取的文檔字段列表否文檔的排序字段及否null；如果不指定序列），找到文檔的引用信息。方法描述：還原廢稿箱中的文檔返回值：無(wú)待恢復(fù)的RecId否否否否是是否是否否方法描述：獲取指定文檔的手工設(shè)定的相關(guān)文檔返回值：相關(guān)文檔Relations對(duì)象是否否EID：wcm6_template對(duì)象類型（站點(diǎn)欄目否目否否0描述：刪除指定的模板返回值：無(wú)是是欄目是否否式否MM-dd否傳查詢的模否查詢的模否查詢的模否查詢ID否=需要排除的模否返回值：Templates對(duì)象模板ID是獲取的字段否返回值：Template對(duì)象是對(duì)象（站點(diǎn)否對(duì)象（站點(diǎn)欄目否獲取的字段否返回值：無(wú)對(duì)象（站點(diǎn)/目是對(duì)象（站點(diǎn)/是描述：獲取指定的模板的使用情況返回值：TemplateEmploys對(duì)象是否對(duì)象（站點(diǎn)/是對(duì)象（站點(diǎn)/目是否否否是否包含子對(duì)否否查詢的模板名否查詢的模板描否查詢的模板創(chuàng)否查詢的否=需要排除的模ID否描述：從指定的文件導(dǎo)入模板返回值：Reports對(duì)象對(duì)象（站點(diǎn)/是對(duì)象（站點(diǎn)/目是需要導(dǎo)入的文件是需要導(dǎo)入的文是否模板重名處理否1模板附件重名否1描述：校驗(yàn)選中的模板對(duì)象（站點(diǎn)/否對(duì)象（站點(diǎn)/目否否是否校驗(yàn)當(dāng)前對(duì)象下所有的否是否校驗(yàn)子對(duì)否描述：校驗(yàn)指定的模板內(nèi)容對(duì)象（站點(diǎn)/是對(duì)象（站點(diǎn)/目是否是描述：同步模板附件參數(shù)對(duì)象（站點(diǎn)/是對(duì)象（站點(diǎn)/目是否是否分發(fā)當(dāng)前對(duì)象下的所有否對(duì)象（站點(diǎn)/是對(duì)象（站點(diǎn)/目是返回值：模板變量的ID(string)對(duì)象（站點(diǎn)/是對(duì)象（站點(diǎn)/目是是是否是描述：設(shè)置對(duì)象的默認(rèn)模板返回值：無(wú)對(duì)象（站點(diǎn)/是對(duì)象（站點(diǎn)是是是描述：設(shè)置對(duì)象的其它概覽模板返回值：無(wú)對(duì)象（站點(diǎn)/是對(duì)象（站點(diǎn)/是是是是是描述：分配模板到指定的欄目或站點(diǎn)返回值：無(wú)是否是否同時(shí)設(shè)置站點(diǎn)的模板關(guān)否描述：校驗(yàn)指定的內(nèi)容否對(duì)象（站點(diǎn)/否對(duì)象（站點(diǎn)/目否否ID：wcm6_publish描述：該類提供了對(duì)發(fā)布設(shè)置及發(fā)布類型的相關(guān)操作服務(wù)，如獲取發(fā)布設(shè)置、保是是否數(shù)Objecttype的默認(rèn)值，我們只需傳入對(duì)象ID即可。如下表所示：是是數(shù)Objecttype的默認(rèn)值，我們只需傳入對(duì)象ID即可。如下表所示：描述：發(fā)布指定的對(duì)象返回值：無(wú)是是否1描述：預(yù)覽指定的對(duì)象的發(fā)布頁(yè)面是是否預(yù)覽文檔時(shí)候否預(yù)覽文檔時(shí)候所在的欄目對(duì)否描述：獲取撤銷發(fā)布計(jì)劃是是描述：設(shè)置對(duì)象的撤銷發(fā)布計(jì)劃返回值：無(wú)是是是否提 描述：保存在指定視圖下提交的數(shù)據(jù)信息返回值：MetaViewData對(duì)象要保存的元數(shù)是否否描述：獲取指定的視圖數(shù)據(jù)傳否否排序字段用否返回的日期否ChnlDoc提取的字段列否返回值：MetaViewDate對(duì)象是否否返回的日期格式否描述：導(dǎo)出元數(shù)據(jù)否否是描述：導(dǎo)出指定視圖或欄目下的所有元數(shù)據(jù)記錄否否描述：批量復(fù)制記錄到目標(biāo)欄目返回值：Reports對(duì)象是列是描述：在指定的欄目下導(dǎo)入指定的視圖返回值：Reports對(duì)象是是需要導(dǎo)入的文件是否描述：將分類法中的記錄移動(dòng)到另一個(gè)分類法下返回值：無(wú)列是列是是描述：將記錄復(fù)制到另一個(gè)分類法中返回值：無(wú)列是目標(biāo)分類法是ID：wcm6_MetaDataDef描述：檢索元數(shù)據(jù)相關(guān)字段信息返回值：MetaDBFields對(duì)象式否傳元數(shù)否元數(shù)否字段否=分類否=查詢否描述：獲取元數(shù)據(jù)結(jié)構(gòu)信息排序字段及否元數(shù)據(jù)別串否名元數(shù)據(jù)名否元數(shù)據(jù)描述否元數(shù)否=查詢創(chuàng)建否式否傳視圖串否視圖串否視圖否=查詢否描述：查詢視圖字段信息式否FieldOrder否否傳視圖否視圖否視圖字段否=分類否=查詢否描述：保存元數(shù)據(jù)表信息是否否否描述：刪除元數(shù)據(jù)表信息是ID序是描述：刪除視圖ID是描述：刪除視圖字段是是否否否否否否否否否否否描述：保存視圖信息是否否否否描述：保存視圖字段信息是否否否否否段否段否否否否否否否否否返回值：MetaView對(duì)象是返回值：MetaViewField對(duì)象是返回值：MetaDBField對(duì)象是描述：從XML文件創(chuàng)建視圖返回值：MetaView對(duì)象否據(jù)是描述：改變視圖字段順序是是否描述：維護(hù)視圖字段：目前僅僅適用單表模式返回值：無(wú)是ID是描述：設(shè)置視圖字段的屬性返回值：無(wú)ID是是是IDID返回值：MetaView對(duì)象是描述：給指定的欄目分配視圖是是描述：獲取指定欄目的視圖是描述：產(chǎn)生視圖的應(yīng)用否是否描述：保存文檔的同步規(guī)則返回值：無(wú)是否否描述：查詢文檔的同步規(guī)則是描述：重新產(chǎn)生元數(shù)據(jù)表的相關(guān)信息返回值：無(wú)是描述：獲取使用了分類法的視圖否描述：獲取使用了視圖的分類法否描述：按照文本文件的定義，創(chuàng)建整個(gè)系統(tǒng)是名是是否否否碼否否描述：從xml文件導(dǎo)入視圖是ID：wcm6_ClassInfo描述：該類提供了對(duì)分類法的一些常用操作服務(wù)，例如保存分類法、獲取指定的是否同級(jí)分類法中的前一個(gè)分類否否否BasicDataHelper.call('wcm6_ClassInfo',BasicDataHelper.call('wcm6_ClassInfo','saveClassInfo',ObjectId:0,},true,success,描述：獲取指定的分類法返回值：ClassInfos對(duì)象否0否否ClassOrder否否否=否BasicDataHelper.call('wcm6_ClassInfo''queryClassInfos'},true,success,描述：根據(jù)多個(gè)父分類法構(gòu)造分類法樹(shù)是分類法樹(shù)產(chǎn)生的否0整數(shù)否0注：type表示分類法產(chǎn)生的方式，type=0表示沿著一條鏈一直展開(kāi)，用于定位到一個(gè)IDS有父子關(guān)系;type!=0IDS序列，用于定id。SelectType0，1，SelectType=0表示可以選擇樹(shù)的每一個(gè)節(jié)點(diǎn);SelectType=1表示僅能選擇樹(shù)的葉子節(jié)點(diǎn)。描述：根據(jù)一個(gè)分類法構(gòu)造分類法樹(shù)否0整數(shù)否0描述：刪除某個(gè)分類法或者多個(gè)分類法返回值：無(wú)待刪除的分類否待刪除的分類ID否示例：返回值：ClassInfo對(duì)象是是ID13ID13BasicDataHelper.call('wcm6_ClassInfo','getPath',{},true,success,返回值：如果存在則返回ClassInfo對(duì)象，否則返回否是否=描述：從外部導(dǎo)入分類法待導(dǎo)入的文件名是否0是否包含分類否否描述：改變順序是否是是否ID：wcm6_auth是ID10ID10BasicDataHelper.call('wcm6_auth','deleteOperatorRight',{ObjectId:10},true,success,是是是,},true,success,該示例表示當(dāng)前登錄用戶給ID為3的角色（wcm對(duì)象類型為203ObjTYPE><ObjID>1</ObjID>）的權(quán)限，權(quán)限值為1000000000000001000000010ID：wcm6_infoview是是提交人的用戶名否表單文檔正文是JSPRequestProcessorprocessor=newJSPRequestProcessor(request,StringsServiceId="wcm6_infoview",sMethodName=HashMapparameters=newparameters.put("channelid","10");部新建一個(gè)表單文檔，查看數(shù)據(jù)庫(kù)WCMDOCUMENT中新添加的這條表單文檔記錄，查看其字段DOCCONTENT中的值，自己構(gòu)造的xml結(jié)構(gòu)與字段DOCCONTENT中的內(nèi)容一致。例如：<?xmlversion="1.0"encoding="UTF-8"?><my:myFieldsStringsXmlContent="";StringsResult=(String)processor.excute(sServiceId,sMethodName,示例：采用DataExchangeStringsServiceId=StringsMethodName=MapoPostData=newHashMap();oPostData.put("channelid","10");/*xml字符串，xmlWCM系統(tǒng)內(nèi)部新建一個(gè)的值，自己構(gòu)造的xml結(jié)構(gòu)與字段DOCCONTENT中的內(nèi)容基本一致。但是需要特別說(shuō)明：由于<?xmlversion="1.0"encoding="UTF-8"?><my:myFields<?xmlversion="1.0"encoding="UTF-8"?><my:myFields<?xmlversion="1.0"encoding="UTF-8"?><my:myFields號(hào)StringsXmlContent="";DispatchoDispatch=WCMServiceCaller.Call(sServiceId,sMethodName,oPostData,false);是為已發(fā)，2為未發(fā)是檢索返回哪些字段的信息（可以添加表單的一些字段，例如ivfield1,ivfield2否key="/my:myFields/my:性別"value="男"/><SearchItemkey="/my:myFields/my:學(xué)歷"value="本科"/></SearchXML>每一個(gè)檢索字段為一個(gè)SearchItem否//使用DataExchange的方式參數(shù)的設(shè)置StringsServiceIdwcm6_infoview";StringsMethodName="queryData";MapoPostData=newHashMap();oPostData.put("DocStatusMode","0");別"value="男"/><SearchItemkey="/my:myFields/my:學(xué)歷"value="本科"/></SearchXML>，每一個(gè)檢索字段是一個(gè)SearchItem節(jié)點(diǎn)StringsSearchXml="";DispatchoDispatch=WCMServiceCaller.Call(sServiceId,sMethodName,oPostData,false);<dataset><dataheader><fieldname="FLOWOPERATIONMARK"desc="狀態(tài)"/><fieldname="DOCIDdesc="文檔編號(hào)"/><fieldname="DOCTITLE"desc="文檔標(biāo)題"/><fieldname="CRTIME"desc="創(chuàng)建時(shí)間"/><fieldname="DOCSTATUS"態(tài)態(tài)js調(diào)用服務(wù)，可以在HTML<script使用DataExchange工具調(diào)用服務(wù)，首先要按照內(nèi)網(wǎng)中的文檔了解DataExchange，/portal/portaldoc/documentshow.jsp?ChannelI