SoTowerBPMWebService参考手册.doc

SoTower BPM 3.1Web Service 参考手册模板编号：CP/B16-TMP04 V1.0.0项目编号：1002-NB-BPM-155文件版次：1.0编写人/日期：张敏杰/2010-12-09审核人/日期：方国/2010-12-11批准人/日期：杨宁/2010-12-11变 更 记 录序号版本号修改单号修改条款及内容修改人/日期批准人/日期注：对该文件内容增加、删除或修改均需填写此变更记录，详细记载变更信息，以保证其可追溯性。目 录1Web Service参考手册11.1流程实例管理服务11.1.1changeProcessInstState11.1.2clearProcessInstTimeLimit11.1.3createProcessInstance21.1.4createProcessInstance21.1.5createProcessInstWithOption31.1.6createProcessInstAlone41.1.7deleteProcessInstance41.1.8querySubProcessInstIDsByActivityInstID41.1.9resumeProcessInstance51.1.10startProcessInstance51.1.11startProcessInstWithOption61.1.12suspendProcessInstance61.1.13terminateProcessInstance71.1.14terminateProcessInstanceAndCompensate71.2活动实例管理服务81.2.1activateActivityInstance81.2.2changeActivityInstState81.2.3createAndStartActivityInstance91.2.4executeRollbackAction101.2.5findActivityInstByActivityInstID101.2.6finishActivityInstance101.2.7finishActivityInstByActivityID111.2.8getActivityInstState121.2.9removeActivityInstance121.2.10restartActivityInstance131.2.11resumeActivityInstance131.2.12suspendActivityInstance131.2.13terminateActivityInstance141.3流程定义查询服务141.3.1getExtendAttribute151.3.2getProcess151.3.3getProcessWithVersion161.3.4queryNextActivities161.3.5queryPreviousActivities171.4流程相关数据管理服务171.4.1getRelativeDataBatch171.4.2setRelativeDataBatch181.4.3removeRelativeDataBatch191.5外部子流程回调服务191.5.1finishSubProcess201.6指派后继活动管理服务201.6.1appointActivityParticipant201.6.2isNeedAppointNextActivityParticipant211.6.3queryAppointedActivityParticipants211.6.4queryNextActivitesNeedAppointParticipant221.7工作项管理服务221.7.1queryWorkItemDetail221.7.2reassignWorkItem231.7.3reassignWorkItemEx231.7.4queryWorkItemsByActivityInstID241.7.5queryWorkItemParticipantInfo241.7.6queryWorkItemUrl251.7.7removeWorkItem251.7.8removeWorkItemParticipant261.7.9terminateWorkItem261.7.10withdrawWorkItem261.7.11modifyWorkItemUrl271.7.12modifyWorkItemName281.7.13addWorkItemParticipant281.7.14assignWorkItemToPerson291.7.15assignWorkItemToSelf291.7.16clearWorkItemParticipant301.7.17finishWorkItemWithOption(未完成)301.7.18finishWorkItem311.7.19queryPersonFinishedWorkItems311.8活动回退管理服务321.8.1backActivity321.8.2getPreviousActivities331.9工作项回拽管理服务331.9.1drawbackWorkItem341.9.2isDrawbackEnable341 Web Service参考手册定义：$ip：流程引擎服务器ip地址。$port：流程引擎服务调用端口。1.1 流程实例管理服务流程实例管理服务功能：实现对流程实例的管理。服务发布地址：http:/$ip:$port/default/services/WSProcessInstManagerService?wsdl。本节将给出流程实例管理服务提供的服务方法的详细介绍1.1.1 changeProcessInstState方法名称changeProcessInstState功能描述改变一个流程实例的状态void changeProcessInstState(java.lang.String userID, long processInstID, int destState) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例IDdestS目标状态返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项1.如果流程实例不存在则抛出异常 ；2.如果流程实例的目标状态不属于可转换状态则抛异常 getProcessInstanceNextStateList方法可以查询后继转换状态备注参数destState的可取值：2（运行）、3（挂起）、7（完成）、8（终止）1.1.2 clearProcessInstTimeLimit方法名称clearProcessInstTimeLimit功能描述取消流程实例上的超时时间和超时提醒void clearProcessInstTimeLimit(String userID, long processInstID, String strategy) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例IDstrategyjava.lang.String取消策略返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项1.如果流程实例不存在则抛出异常；2.如果清除策略不对则抛异常备注参数strategy 的可取值：ALL（全部）、LimitTime（超时时间）、RemindTime（超时提醒）1.1.3 createProcessInstance方法名称clearProcessInstTimeLimit功能描述取消流程实例上的超时时间和超时提醒void clearProcessInstTimeLimit(String userID, long processInstID, String strategy) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例IDstrategyjava.lang.String取消策略返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注参数strategy 的可取值：ALL（全部）、LimitTime（超时时间）、RemindTime（超时提醒）1.1.4 createProcessInstance方法名称createProcessInstance功能描述创建工作流实例并选择是否启动long createProcessInstance(String userID, String processDefName, String processInstName, String processInstDesc, boolean isStart) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessDefNamejava.lang.long业务流程定义名称processInstNamejava.lang.String业务流程实例名称processInstDescjava.lang.String业务流程实例描述isStartboolean是否启动流程实例返回值返回值类型返回值描述java.lang.long流程实例ID抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.1.5 createProcessInstWithOption方法名称createProcessInstWithOption功能描述创建工作流实例并选择是否启动long createProcessInstWithOption(String userID, String processDefName, String processInstName, String processInstDesc, boolean isStart, org.sotower.bpm.api.webservice.data.SimpleCreateOption option) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessDefNamejava.lang.long业务流程定义名称processInstNamejava.lang.String业务流程实例名称processInstDescjava.lang.String业务流程实例描述isStartboolean是否启动流程实例optionSimpleCreateOption启动参数返回值返回值类型返回值描述java.lang.long流程实例ID抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注参数option的类型介绍org.sotower.bpm.api.webservice.data.SimpleCreateOption的四个属性和类型：Map relativeData（业务流程的相关数据）String version（业务流程定义的版本）String parameters（流程启动参数）long parentActivityInstID（父流程实例ID）1.1.6 createProcessInstAlone方法名称createProcessInstAlone功能描述创建业务流程实例并启动long createProcessInstAlone(String userID, String processDefName, String processInstName, String processInstDesc) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessDefNamejava.lang.long业务流程定义名称processInstNamejava.lang.String业务流程实例名称processInstDescjava.lang.String业务流程实例描述返回值返回值类型返回值描述java.lang.long流程实例ID抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.1.7 deleteProcessInstance方法名称deleteProcessInstance功能描述根据流程实例ID删除流程实例int deleteProcessInstance(java.lang.String userID, long processInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long业务流程实例ID返回值返回值类型返回值描述java.lang.long成功删除返回1抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.1.8 querySubProcessInstIDsByActivityInstID方法名称querySubProcessInstIDsByActivityInstID功能描述根据子流程活动实例ID查询活动对应的子流程实例ID列表long querySubProcessInstIDsByActivityInstID(java.lang.String userID, long subActInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDsubActInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述java.lang.long型数组子活动实例ID列表抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注如果活动实例不是子流程、或者活动实例或者活动对应的子流程流程实例不存在则抛出异常；如果活动实例只有一个子流程实例则返回长度是一的流程ID数组,否则长度大于一1.1.9 resumeProcessInstance方法名称resumeProcessInstance功能描述恢复某个被挂起的流程实例void resumeProcessInstance(java.lang.String userID, long processInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例ID返回值返回值类型返回值描述无 无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.1.10 startProcessInstance方法名称startProcessInstance功能描述启动工作流实例(指定启动点)void startProcessInstance(java.lang.String userID, long processInstID, String startPortID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例IDstartPortIDjava.lang.String启动点ID返回值返回值类型返回值描述无 无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.1.11 startProcessInstWithOption方法名称startProcessInstWithOption功能描述启动工作流实例,可根据参数选择是否完成第一个工作项等void startProcessInstWithOption(java.lang.String userID, long processInstID, org.sotower.bpm.api.webservice.data.SimpleStartOption startOption) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例IDstartOptionSimpleStartOption启动选项返回值返回值类型返回值描述无 无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注参数startOption的类型介绍org.sotower.bpm.api.webservice.data.SimpleStartOption的四个属性和类型：Map relativeData（业务流程的相关数据）String startEvent（业务流程实例的启动点ID）String parameters（流程启动参数）boolean finishFirstWorkItem（是否完成第一个工作项）boolean isAllowedMessageStart （是否允许消息开始事件）1.1.12 suspendProcessInstance方法名称suspendProcessInstance功能描述挂起某个流程实例void suspendProcessInstance(java.lang.String userID, long processInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例ID返回值返回值类型返回值描述无 无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.1.13 terminateProcessInstance方法名称terminateProcessInstance功能描述终止某个流程实例void terminateProcessInstance (java.lang.String userID, long processInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例ID返回值返回值类型返回值描述无 无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.1.14 terminateProcessInstanceAndCompensate方法名称terminateProcessInstanceAndCompensate功能描述终止某个流程实例，并调用流程和活动上已经配置的回退补偿void terminateProcessInstanceAndCompensate (java.lang.String userID, long processInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例ID返回值返回值类型返回值描述无 无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.2 活动实例管理服务活动实例管理服务功能：实现对活动实例的管理，可以对活动实例进行查询，如查询指定流程下的活动实例；也可以对活动实例进行多种操作，比如完成，重启，删除等。服务发布地址：http:/$ip:$port/default/services/WSActivityInstManagerService?wsdl本节将介绍活动实例管理服务提供的服务。1.2.1 activateActivityInstance方法名称activateActivityInstance功能描述用于激活一个待激活、未启动状态的活动void activateActivityInstance(java.lang.String userID, long activityInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactivityInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述无 无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项调用该方法时要求活动处于待激活或者未启动状态，否则会抛异常备注无1.2.2 changeActivityInstState方法名称changeActivityInstState功能描述改变一个活动实例状态void changeActivityInstState (java.lang.String userID, long activityInstID, int destState) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactivityInstIDjava.lang.long活动实例IDdestStateint目标状态返回值返回值类型返回值描述无 无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项1.未找到活动实例会抛出异常；2.目标状态,必须是后继可能转换的状态备注参数destState可取值：1（未运行）、10（待激活）、2（运行）、3（挂起）、7（完成）、8（终止）、-1（应用异常）、6（取消）1.2.3 createAndStartActivityInstance方法名称createAndStartActivityInstance功能描述根据流程实例ID和活动定义ID创建并启动一个未运行到的活动long createAndStartActivityInstance (String userID, long activityInstID, int destState) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例IDactivityDefIDjava.lang.String活动定义ID返回值返回值类型返回值描述java.lang.long活动定义ID抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项未找到流程实例会抛出异常备注无1.2.4 executeRollbackAction方法名称executeRollbackAction功能描述根据流程实例ID和活动定义ID创建并启动一个未运行到的活动void executeRollbackAction(java.lang.String userID, long activityInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactivityInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.2.5 findActivityInstByActivityInstID方法名称findActivityInstByActivityInstID功能描述根据活动实例ID查询活动实例org.sotower.workflow.data.WFActivityInst findActivityInstByActivityInstID(.String userID, long actInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述org.sotower.workflow.data.WFActivityInst活动实例抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项无备注无1.2.6 finishActivityInstance方法名称finishActivityInstance功能描述完成活动实例void finishActivityInstance(java.lang.String userID, long activityInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactivityInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项1.如果活动实例不存在会抛异常；2.如果活动实例对应的流程实例不处于运行状态会抛异常；3.如果活动实例应该处于运行状态，否则会抛异常；4.完成活动实例动作会自动终止未结束的工作项备注无1.2.7 finishActivityInstByActivityID方法名称finishActivityInstByActivityID功能描述完成某个流程实例下的某个活动定义对应的活动实例void finishActivityInstByActivityID(String userID, long processInstID, String activityDefID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDprocessInstIDjava.lang.long流程实例IDactivityDefIDjava.lang.String活动定义ID返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项多个活动实例的情况只完成最新的活动实例备注无1.2.8 getActivityInstState方法名称getActivityInstState功能描述查询个活动实例的状态int getActivityInstState(java.lang.String userID, long activityInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactivityInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述int活动实例状态抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项如果活动实例不存在会抛出异常备注返回值可能的取值：1（未运行）、10（待激活）、2（运行）、3（挂起）、7（完成）、8（终止）、-1（应用异常）、6（取消）1.2.9 removeActivityInstance方法名称removeActivityInstance功能描述删除活动实例int removeActivityInstance (java.lang.String userID, long actInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述int成功返回1抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项如果活动实例不存在会抛出异常备注返回值可能的取值：1（未运行）、10（待激活）、2（运行）、3（挂起）、7（完成）、8（终止）、-1（应用异常）、6（取消）1.2.10 restartActivityInstance方法名称restartActivityInstance功能描述重新启动某个活动实例int restartActivityInstance (java.lang.String userID, long activityInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactivityInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项如果活动实例不存在会抛出异常备注要求活动实例所属的流程处于运行状态，否则会抛异常1.2.11 resumeActivityInstance方法名称resumeActivityInstance功能描述恢复某个活动实例的状态为运行状态int resumeActivityInstance (java.lang.String userID, long activityInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactivityInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项要求活动实例的状态处于挂起状态，否则会抛异常备注1.2.12 suspendActivityInstance方法名称suspendActivityInstance功能描述挂起某个活动实例int suspendActivityInstance (java.lang.String userID, long activityInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactivityInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项要求活动实例的状态处于运行状态,否则会抛异常备注1.2.13 terminateActivityInstance方法名称terminateActivityInstance功能描述终止活动实例int terminateActivityInstance (java.lang.String userID, long activityInstID) throws org.sotower.bpm.model.exception.WFWebServiceException参数参数名称参数类型参数描述userIDjava.lang.String用户IDactivityInstIDjava.lang.long活动实例ID返回值返回值类型返回值描述无无抛出异常org.sotower.bpm.model.exception.WFWebServiceException注意事项1.如果活动实例不存在会抛异常；2.如果活动实例的状态处于完成或者终止状态会抛异常备注1.3 流程定义查询服务流程定义查询服务功能：主要提供业务流程管理中需要使用的查询接口， 可以查询业务流程实体、活动定义实体、连线实体、流程包列表、流程目录、活动已经定义的参与者等信息。服务发布地址：http:/$ip:$port/default/services/WSDefinitionQueryManagerService?wsdl本节将介绍流程定义查询服务提供的服务。1.3.1 getExtendAttribute方法名称getExtendAttribute功能描述获取业务流程或者活动定义的扩展属性XML字符串java.lang.String getExtendAttribute(String userID, long processDefID, String activityDefID) throws org.sotower