IBM Business Process Manager provides a Web service interface for accessing business processes, human tasks, and related resources.
The Web service operations for BPEL Processes and related resources are defined in the XML namespace "http://www.ibm.com/xmlns/prod/websphere/business-process/services/7.0".
| Operation Name | Input | Output | Faults |
|---|---|---|---|
| call | call parameter elements:
|
callResponse parameter elements:
|
call faults:
|
| callAsync | callAsync parameter elements:
|
callAsyncResponse parameter elements: None | callAsync faults:
|
| completeAndClaimSuccessor | completeAndClaimSuccessor parameter elements:
|
completeAndClaimSuccessorResponse parameter elements:
|
completeAndClaimSuccessor faults:
|
| createStoredQuery | createStoredQuery parameter elements:
|
createStoredQueryResponse parameter elements: None | createStoredQuery faults:
|
| delete | delete parameter elements:
|
deleteResponse parameter elements: None | delete faults:
|
| deleteStoredQuery | deleteStoredQuery parameter elements:
|
deleteStoredQueryResponse parameter elements: None | deleteStoredQuery faults:
|
| executeStoredQuery | executeStoredQuery parameter elements:
|
executeStoredQueryResponse parameter elements:
|
executeStoredQuery faults:
|
| findQueryTableMetaData | findQueryTableMetaData parameter elements:
|
findQueryTableMetaDataResponse parameter elements:
|
findQueryTableMetaData faults:
|
| forceComplete | forceComplete parameter elements:
|
forceCompleteResponse parameter elements: None | forceComplete faults:
|
| forceCompleteWithFault | forceCompleteWithFault parameter elements:
|
forceCompleteWithFaultResponse parameter elements: None | forceCompleteWithFault faults:
|
| forceCompleteWithOutput | forceCompleteWithOutput parameter elements:
|
forceCompleteWithOutputResponse parameter elements: None | forceCompleteWithOutput faults:
|
| forceRetry | forceRetry parameter elements:
|
forceRetryResponse parameter elements: None | forceRetry faults:
|
| forceRetryWithInput | forceRetryWithInput parameter elements:
|
forceRetryWithInputResponse parameter elements: None | forceRetryWithInput faults:
|
| forceTerminate | forceTerminate parameter elements:
|
forceTerminateResponse parameter elements: None | forceTerminate faults:
|
| getActiveEventHandlers | getActiveEventHandlers parameter elements:
|
getActiveEventHandlersResponse parameter elements:
|
getActiveEventHandlers faults:
|
| getActivityInstance | getActivityInstance parameter elements:
|
getActivityInstanceResponse parameter elements:
|
getActivityInstance faults:
|
| getCustomPropertiesOfActivityInstance | getCustomPropertiesOfActivityInstance parameter elements:
|
getCustomPropertiesOfActivityInstanceResponse parameter elements:
|
getCustomPropertiesOfActivityInstance faults:
|
| getCustomPropertiesOfProcessInstance | getCustomPropertiesOfProcessInstance parameter elements:
|
getCustomPropertiesOfProcessInstanceResponse parameter elements:
|
getCustomPropertiesOfProcessInstance faults:
|
| getCustomPropertiesOfProcessTemplate | getCustomPropertiesOfProcessTemplate parameter elements:
|
getCustomPropertiesOfProcessTemplateResponse parameter elements:
|
getCustomPropertiesOfProcessTemplate faults:
|
| getFaultMessageForActivityInstance | getFaultMessageForActivityInstance parameter elements:
|
getFaultMessageForActivityInstanceResponse parameter elements:
|
getFaultMessageForActivityInstance faults:
|
| getFaultMessageForProcessInstance | getFaultMessageForProcessInstance parameter elements:
|
getFaultMessageForProcessInstanceResponse parameter elements:
|
getFaultMessageForProcessInstance faults:
|
| getFaults | getFaults parameter elements:
|
getFaultsResponse parameter elements:
|
getFaults faults:
|
| getInputMessageForActivityInstance | getInputMessageForActivityInstance parameter elements:
|
getInputMessageForActivityInstanceResponse parameter elements:
|
getInputMessageForActivityInstance faults:
|
| getInputMessageForProcessInstance | getInputMessageForProcessInstance parameter elements:
|
getInputMessageForProcessInstanceResponse parameter elements:
|
getInputMessageForProcessInstance faults:
|
| getMessageTextOfException | getMessageTextOfException parameter elements:
|
getMessageTextOfExceptionResponse parameter elements:
|
getMessageTextOfException faults:
|
| getOutputMessageForActivityInstance | getOutputMessageForActivityInstance parameter elements:
|
getOutputMessageForActivityInstanceResponse parameter elements:
|
getOutputMessageForActivityInstance faults:
|
| getOutputMessageForProcessInstance | getOutputMessageForProcessInstance parameter elements:
|
getOutputMessageForProcessInstanceResponse parameter elements:
|
getOutputMessageForProcessInstance faults:
|
| getParticipatingTaskID | getParticipatingTaskID parameter elements:
|
getParticipatingTaskIDResponse parameter elements:
|
getParticipatingTaskID faults:
|
| getProcessInstance | getProcessInstance parameter elements:
|
getProcessInstanceResponse parameter elements:
|
getProcessInstance faults:
|
| getProcessTemplate | getProcessTemplate parameter elements:
|
getProcessTemplateResponse parameter elements:
|
getProcessTemplate faults:
|
| getQueryProperties | getQueryProperties parameter elements:
|
getQueryPropertiesResponse parameter elements:
|
getQueryProperties faults:
|
| getQueryTableMetaData | getQueryTableMetaData parameter elements:
|
getQueryTableMetaDataResponse parameter elements:
|
getQueryTableMetaData faults:
|
| getStartActivities | getStartActivities parameter elements:
|
getStartActivitiesResponse parameter elements:
|
getStartActivities faults:
|
| getStoredQuery | getStoredQuery parameter elements:
|
getStoredQueryResponse parameter elements:
|
getStoredQuery faults:
|
| getStoredQueryNames | getStoredQueryNames parameter elements: None | getStoredQueryNamesResponse parameter elements:
|
getStoredQueryNames faults:
|
| getVariableOfActivityInstance | getVariableOfActivityInstance parameter elements:
|
getVariableOfActivityInstanceResponse parameter elements:
|
getVariableOfActivityInstance faults:
|
| getVariableOfProcessInstance | getVariableOfProcessInstance parameter elements:
|
getVariableOfProcessInstanceResponse parameter elements:
|
getVariableOfProcessInstance faults:
|
| getWaitingActivities | getWaitingActivities parameter elements:
|
getWaitingActivitiesResponse parameter elements:
|
getWaitingActivities faults:
|
| initiateAndClaimFirst | initiateAndClaimFirst parameter elements:
|
initiateAndClaimFirstResponse parameter elements:
|
initiateAndClaimFirst faults:
|
| query | query parameter elements:
|
queryResponse parameter elements:
|
query faults:
|
| queryAll | queryAll parameter elements:
|
queryAllResponse parameter elements:
|
queryAll faults:
|
| queryEntities | queryEntities parameter elements:
|
queryEntitiesResponse parameter elements:
|
queryEntities faults:
|
| queryEntityCount | queryEntityCount parameter elements:
|
queryEntityCountResponse parameter elements:
|
queryEntityCount faults:
|
| queryProcessTemplates | queryProcessTemplates parameter elements:
|
queryProcessTemplatesResponse parameter elements:
|
queryProcessTemplates faults:
|
| restart | restart parameter elements:
|
restartResponse parameter elements: None | restart faults:
|
| resume | resume parameter elements:
|
resumeResponse parameter elements: None | resume faults:
|
| sendMessage | sendMessage parameter elements:
|
sendMessageResponse parameter elements:
|
sendMessage faults:
|
| setCustomPropertyForActivityInstance | setCustomPropertyForActivityInstance parameter elements:
|
setCustomPropertyForActivityInstanceResponse parameter elements: None | setCustomPropertyForActivityInstance faults:
|
| setCustomPropertyForProcessInstance | setCustomPropertyForProcessInstance parameter elements:
|
setCustomPropertyForProcessInstanceResponse parameter elements: None | setCustomPropertyForProcessInstance faults:
|
| setCustomPropertyUsingActivityName | setCustomPropertyUsingActivityName parameter elements:
|
setCustomPropertyUsingActivityNameResponse parameter elements: None | setCustomPropertyUsingActivityName faults:
|
| setVariableForActivityInstance | setVariableForActivityInstance parameter elements:
|
setVariableForActivityInstanceResponse parameter elements: None | setVariableForActivityInstance faults:
|
| setVariableForProcessInstance | setVariableForProcessInstance parameter elements:
|
setVariableForProcessInstanceResponse parameter elements: None | setVariableForProcessInstance faults:
|
| suspend | suspend parameter elements:
|
suspendResponse parameter elements: None | suspend faults:
|
| suspendFor | suspendFor parameter elements:
|
suspendForResponse parameter elements: None | suspendFor faults:
|
| suspendUntil | suspendUntil parameter elements:
|
suspendUntilResponse parameter elements: None | suspendUntil faults:
|
The Web service operations for BPEL Human Tasks and related resources are defined in the XML namespace "http://www.ibm.com/xmlns/prod/websphere/human-task/services/7.0".
| Operation Name | Input | Output | Faults |
|---|---|---|---|
| callAsync | callAsync parameter elements:
|
callAsyncResponse parameter elements: None | callAsync faults:
|
| callTask | callTask parameter elements:
|
callTaskResponse parameter elements:
|
callTask faults:
|
| cancelClaim | cancelClaim parameter elements:
|
cancelClaimResponse parameter elements: None | cancelClaim faults:
|
| claim | claim parameter elements:
|
claimResponse parameter elements:
|
claim faults:
|
| claimByQuery | claimByQuery parameter elements:
|
claimByQueryResponse parameter elements:
|
claimByQuery faults:
|
| complete | complete parameter elements:
|
completeResponse parameter elements: None | complete faults:
|
| completeWithFault | completeWithFault parameter elements:
|
completeWithFaultResponse parameter elements: None | completeWithFault faults:
|
| completeWithFollowOnTask | completeWithFollowOnTask parameter elements:
|
completeWithFollowOnTaskResponse parameter elements: None | completeWithFollowOnTask faults:
|
| completeWithNewFollowOnTask | completeWithNewFollowOnTask parameter elements:
|
completeWithNewFollowOnTaskResponse parameter elements: None | completeWithNewFollowOnTask faults:
|
| completeWithOutput | completeWithOutput parameter elements:
|
completeWithOutputResponse parameter elements: None | completeWithOutput faults:
|
| createAndCallTask | createAndCallTask parameter elements:
|
createAndCallTaskResponse parameter elements:
|
createAndCallTask faults:
|
| createAndStartTask | createAndStartTask parameter elements:
|
createAndStartTaskResponse parameter elements:
|
createAndStartTask faults:
|
| createAndStartTaskAsSubTask | createAndStartTaskAsSubTask parameter elements:
|
createAndStartTaskAsSubTaskResponse parameter elements:
|
createAndStartTaskAsSubTask faults:
|
| createStoredQuery | createStoredQuery parameter elements:
|
createStoredQueryResponse parameter elements: None | createStoredQuery faults:
|
| createTask | createTask parameter elements:
|
createTaskResponse parameter elements:
|
createTask faults:
|
| createWorkItem | createWorkItem parameter elements:
|
createWorkItemResponse parameter elements: None | createWorkItem faults:
|
| deleteStoredQuery | deleteStoredQuery parameter elements:
|
deleteStoredQueryResponse parameter elements: None | deleteStoredQuery faults:
|
| deleteTask | deleteTask parameter elements:
|
deleteTaskResponse parameter elements: None | deleteTask faults:
|
| deleteWorkItem | deleteWorkItem parameter elements:
|
deleteWorkItemResponse parameter elements: None | deleteWorkItem faults:
|
| executeStoredQuery | executeStoredQuery parameter elements:
|
executeStoredQueryResponse parameter elements:
|
executeStoredQuery faults:
|
| findQueryTableMetaData | findQueryTableMetaData parameter elements:
|
findQueryTableMetaDataResponse parameter elements:
|
findQueryTableMetaData faults:
|
| getActivityID | getActivityID parameter elements:
|
getActivityIDResponse parameter elements:
|
getActivityID faults:
|
| getCustomPropertiesForTaskInstance | getCustomPropertiesForTaskInstance parameter elements:
|
getCustomPropertiesForTaskInstanceResponse parameter elements:
|
getCustomPropertiesForTaskInstance faults:
|
| getCustomPropertiesForTaskTemplate | getCustomPropertiesForTaskTemplate parameter elements:
|
getCustomPropertiesForTaskTemplateResponse parameter elements:
|
getCustomPropertiesForTaskTemplate faults:
|
| getEscalation | getEscalation parameter elements:
|
getEscalationResponse parameter elements:
|
getEscalation faults:
|
| getEscalationTemplate | getEscalationTemplate parameter elements:
|
getEscalationTemplateResponse parameter elements:
|
getEscalationTemplate faults:
|
| getFaultMessage | getFaultMessage parameter elements:
|
getFaultMessageResponse parameter elements:
|
getFaultMessage faults:
|
| getHtmConfiguration | getHtmConfiguration parameter elements: None | getHtmConfigurationResponse parameter elements:
|
getHtmConfiguration faults:
|
| getInputMessage | getInputMessage parameter elements:
|
getInputMessageResponse parameter elements:
|
getInputMessage faults:
|
| getMessageTextOfException | getMessageTextOfException parameter elements:
|
getMessageTextOfExceptionResponse parameter elements:
|
getMessageTextOfException faults:
|
| getOutputMessage | getOutputMessage parameter elements:
|
getOutputMessageResponse parameter elements:
|
getOutputMessage faults:
|
| getProcessID | getProcessID parameter elements:
|
getProcessIDResponse parameter elements:
|
getProcessID faults:
|
| getQueryTableMetaData | getQueryTableMetaData parameter elements:
|
getQueryTableMetaDataResponse parameter elements:
|
getQueryTableMetaData faults:
|
| getStoredQuery | getStoredQuery parameter elements:
|
getStoredQueryResponse parameter elements:
|
getStoredQuery faults:
|
| getStoredQueryNames | getStoredQueryNames parameter elements: None | getStoredQueryNamesResponse parameter elements:
|
getStoredQueryNames faults:
|
| getSubTaskIDs | getSubTaskIDs parameter elements:
|
getSubTaskIDsResponse parameter elements:
|
getSubTaskIDs faults:
|
| getTask | getTask parameter elements:
|
getTaskResponse parameter elements:
|
getTask faults:
|
| getTaskTemplate | getTaskTemplate parameter elements:
|
getTaskTemplateResponse parameter elements:
|
getTaskTemplate faults:
|
| getUsersInRole | getUsersInRole parameter elements:
|
getUsersInRoleResponse parameter elements:
|
getUsersInRole faults:
|
| getUserSubstitutionDetail | getUserSubstitutionDetail parameter elements:
|
getUserSubstitutionDetailResponse parameter elements:
|
getUserSubstitutionDetail faults:
|
| query | query parameter elements:
|
queryResponse parameter elements:
|
query faults:
|
| queryAll | queryAll parameter elements:
|
queryAllResponse parameter elements:
|
queryAll faults:
|
| queryEntities | queryEntities parameter elements:
|
queryEntitiesResponse parameter elements:
|
queryEntities faults:
|
| queryEntityCount | queryEntityCount parameter elements:
|
queryEntityCountResponse parameter elements:
|
queryEntityCount faults:
|
| queryTaskTemplates | queryTaskTemplates parameter elements:
|
queryTaskTemplatesResponse parameter elements:
|
queryTaskTemplates faults:
|
| resolveStaffQuery | resolveStaffQuery parameter elements:
|
resolveStaffQueryResponse parameter elements:
|
resolveStaffQuery faults:
|
| resume | resume parameter elements:
|
resumeResponse parameter elements: None | resume faults:
|
| setCustomPropertiesForTaskInstance | setCustomPropertiesForTaskInstance parameter elements:
|
setCustomPropertiesForTaskInstanceResponse parameter elements: None | setCustomPropertiesForTaskInstance faults:
|
| setFaultMessage | setFaultMessage parameter elements:
|
setFaultMessageResponse parameter elements: None | setFaultMessage faults:
|
| setInputMessage | setInputMessage parameter elements:
|
setInputMessageResponse parameter elements: None | setInputMessage faults:
|
| setOutputMessage | setOutputMessage parameter elements:
|
setOutputMessageResponse parameter elements: None | setOutputMessage faults:
|
| setUserSubstitutionDetail | setUserSubstitutionDetail parameter elements:
|
setUserSubstitutionDetailResponse parameter elements: None | setUserSubstitutionDetail faults:
|
| startTask | startTask parameter elements:
|
startTaskResponse parameter elements: None | startTask faults:
|
| startTaskAsSubTask | startTaskAsSubTask parameter elements:
|
startTaskAsSubTaskResponse parameter elements: None | startTaskAsSubTask faults:
|
| suspend | suspend parameter elements:
|
suspendResponse parameter elements: None | suspend faults:
|
| suspendFor | suspendFor parameter elements:
|
suspendForResponse parameter elements: None | suspendFor faults:
|
| suspendForAndCancelClaim | suspendForAndCancelClaim parameter elements:
|
suspendForAndCancelClaimResponse parameter elements: None | suspendForAndCancelClaim faults:
|
| suspendUntil | suspendUntil parameter elements:
|
suspendUntilResponse parameter elements: None | suspendUntil faults:
|
| suspendUntilAndCancelClaim | suspendUntilAndCancelClaim parameter elements:
|
suspendUntilAndCancelClaimResponse parameter elements: None | suspendUntilAndCancelClaim faults:
|
| terminate | terminate parameter elements:
|
terminateResponse parameter elements: None | terminate faults:
|
| transferWorkItem | transferWorkItem parameter elements:
|
transferWorkItemResponse parameter elements: None | transferWorkItem faults:
|
| update | update parameter elements:
|
updateResponse parameter elements: None | update faults:
|
Parent Topic: Web Service API