IBM Business Process Manager provides a Web service interface for accessing BPMN business processes, coaches, and related resources.
The Web service operations for BPMN Processes and related resources are defined in the XML namespace "http://webapi.lombardisoftware.com".
Name | Description |
---|---|
AbortProcessInstance | Stop a process instance |
AbortProcessInstances | Stop the process instances |
AddComment | Adds comment to specified instance |
AddHelpRequest | Adds help request to specified instance |
AssignTask | Assign a task to current user from a role to which the user belongs. This operation is only valid for tasks that are currently assigned to a role. Invoking this operation on tasks that are already assigned to the current user will result in an exception. |
AssignTasks | Assign multiple tasks to the current user from a role to which the user belongs. This operation is only valid for tasks that are currently assigned to a role. Invoking this operation on tasks that are already assigned to the current user will result in an exception. |
ChangeProcessInstanceDueDate | Change a process instance's due date |
ChangeProcessInstancesDueDate | Change the process instance's due dates |
ChangeTaskDueDate | Change the due date of a task |
ChangeTaskPriority | Change a task priority and, optionally, its due date |
ChangeTasksDueDate | Change the due date of tasks |
ChangeTasksPriority | Change the priority of tasks, and optionally their due dates |
CompleteTask |
Complete a task for an activity in a process instance. This requires that the task is not closed and is assigned to the current user or to a role to which the current user belongs. The activity implementation for this task must be an external activity or a service. For InfoPath activity implementations, use one of the operations of each SubmitInfoPathForm instead. A successful invocation of this operation will close the task using the current user's identity and will send an asynchronous notification of the task's completion to the process engine for the process instance that is associated with the task. This operation then returns. Some time later, the process engine will receive the notification of the task's completion and will resume execution of the process instance. It will map the outputs according to the data mappings defined in the process for the task's activity. It will then continue execution of the steps that follow the completed task's activity in the process. If the task implementation is external activity, then the outputs are saved in the ExternalActivityData when the task is closed. If the task is subsequently accessed (for example using a History search or by using GetProcessInstance), these output values will be visible. If the output variable has the same name as an input, then its value will overwrite the input variable's value. Thus if you want to view both the input and output values for a completed external activity task, then the parameters should be uniquely named (perhaps using "In" and "Out" postfixes). |
CreateDocument | Creates document |
DeleteDocument | Deletes the document with all its revisions and assigned properties |
DueDateOkForTask | Check the availability of the recipients of a task using their calendars |
ExecuteSearch | Run a search to retrieve task or process instance related information |
GetActionPermissions | Get a set of action states that are associated with a list of process instances, tasks, or both |
GetAdHocStartingPoints | Deprecated - ad hoc events are deprecated since version 8.5.5. Use an activity that has no input wire instead of an ad hoc event. Get the list of ad hoc actions that are available on the process instance |
GetAllRoles | Get all roles in the system |
GetAllUsers | Returns all users |
GetCurrentUser | Get the current user |
GetDocument | Returns document for specific document ID |
GetDocumentsForProcessInstance | Returns the documents for a specific process instance ID |
GetDocumentsForProperties | Returns a collection of documents attached to the process instance with the given processInstanceId, and matched by given properties with given matching mode (AND/OR). |
GetExposedItems | Get the items exposed to the user |
GetFavorites | Get the favorites visible to the user |
GetPriorities | Get the priorities in the system |
GetProcessBySystemId | Get a process by its system identifier |
GetProcessInstance | Get a process instance |
GetProcessInstancesBusinessData | Get the business data for multiple process instances |
GetProcessInstancesForSavedSearch | Get the process instances returned by the execution of a saved search. This will temporarily alter the definition of the saved search (in memory) to organize its results by process instance and to include all of the process and process instance fields. |
GetRoleByName | Returns user group information for specific user group name |
GetSavedSearches | Get the saved searches visible to the user |
GetScoreboardData | Get the scoreboard data for the scoreboard |
GetScoreboards | Get the scoreboards visible to the user |
GetSearchMetaData | Returns the available search columns that can be used in searches |
GetSearchMetaDataForProcess | Returns the available business data search columns for a process |
GetServerInfo | Get information about the server including its version |
GetTask | Get the task. Return the task object fully populated (including the ProcessInstance element). |
GetTasksForSavedSearch | Get the tasks returned by the execution of a saved search. This will temporarily alter the definition of the saved search (in memory) to organize its results by task and to include all of the process, process instance, and task fields. |
GetUserByName | Returns user information for specific user name |
GetUserConfiguration | Get all the user configuration information in one call |
IgnoreHelpRequest | Ignores help request |
ReassignTask | Reassign a task back to its original role |
ReassignTasks | Reassign the tasks back to their original roles |
ReassignTasksToRole | Reassign the tasks to a role |
ReassignTasksToUser | Reassign the tasks to a user |
ReassignTaskToRole | Reassign a task to a role |
ReassignTaskToUser | Reassign a task to a user |
RefreshGroupMembership | Refresh the group membership to sync up with the external user directory by invoking this operation. Please make sure the refresh timeout is greater than the time needed for the application server to refresh its cache for searching the external user directory. |
ReplyHelpRequest | Replies to help request |
ResumeProcessInstance | Resume a process instance |
ResumeProcessInstances | Resume the process instances |
RunFavorite | Run a favorite and return a task if it exists |
SendTask | Send a task |
StartAdHocStartingPoint | Deprecated - ad hoc events are deprecated since version 8.5.5. Use an activity that has no input wire instead of an ad hoc event. Run the ad hoc action |
StartExposedItem | Start an exposed item and return a task if it exists |
StartProcess | Start a process and create a new process instance |
StartProcessWithInfoPathForm | Start a process and create a new process instance with the output of an InfoPath form. The process must have an InfoPath Form Start Event with an attached form that matches the submitted form data. |
StartTask |
Start a task for an activity in a process instance. This requires that the task is not closed and is assigned to the current user or to a role to which the current user belongs. The activity implementation for this task must be an external activity or a service. An external application should invoke this operation when it actually starts execution of a task. A successful invocation of this operation will record the task's start time using the current user's identity. |
SubmitInfoPathForm | Submit an InfoPath form that is associated with a task ID and a form data. |
SubmitInfoPathForms | Submit several InfoPath forms. Takes two equal length arrays of task IDs and corresponding form datas. |
SuspendProcessInstance | Suspend a process instance |
SuspendProcessInstances | Suspend the process instances |
SynchronizeTaskLists | Synchronize task lists by passing in information describing the task lists stored on the client and receive back information about task synchronization actions to take on the client to synchronize the client's state with the current state on the server. The client should create a task list synchronization input for each saved search being synchronized with the server. This contains the saved search ID, last synchronization date, and a comma separated string listing the task IDs present (active) on the client. The implementation should create an output for each input. The task list synchronization output object will contain the saved search ID, the synchronization date, and a list of task synchronization actions. The task synchronization action specifies one of three actions: - add - update - remove Add and update actions will contain the task details. Remove actions will only contain the task ID. The client can iterate over these actions applying them to the client side storage to bring it into sync with the server. |
TestConnection | Test the connection to this web service by invoking this operation |
UpdateDocument | Creates new version of a document |
processInstanceId
- The process instance ID of the process instance to stopprocessInstanceIds
- The process instance IDs of the process instances to stopprocessInstanceId
- ID of instancecomment
- comment for addprocessInstanceId
- ID of instancesendTo
- who receives the requestdescription
- description of help requesttaskId
- the ID of task that should be assigned to current usertaskIds
- the IDs of the tasks that should be assigned to the current userprocessInstanceId
- The process instance ID of the process instance to changedueDate
- New due date of the process instanceprocessInstanceIds
- The process instance IDs of the process instances to changedueDate
- New due date of the process instancestaskId
- the ID of the task to changedueDate
- the new due date of the tasktaskId
- the ID of the task to changepriorityId
- the ID of the new prioritychangeDueDate
- if true, then update the due date based the new prioritytaskIds
- the IDs of the tasks to changedueDate
- the new due date of the taskstaskIds
- the IDs of the tasks to changepriorityId
- the ID of the new prioritychangeDueDate
- if true, then update the due date based the new priorityComplete a task for an activity in a process instance. This requires that the task is not closed and is assigned to the current user or to a role to which the current user belongs. The activity implementation for this task must be an external activity or a service. For InfoPath activity implementations, use one of the operations of each SubmitInfoPathForm instead.
A successful invocation of this operation will close the task using the current user's identity and will send an asynchronous notification of the task's completion to the process engine for the process instance that is associated with the task. This operation then returns.
Some time later, the process engine will receive the notification of the task's completion and will resume execution of the process instance. It will map the outputs according to the data mappings defined in the process for the task's activity. It will then continue execution of the steps that follow the completed task's activity in the process.
If the task implementation is external activity, then the outputs are saved in the ExternalActivityData when the task is closed. If the task is subsequently accessed (for example using a History search or by using GetProcessInstance), these output values will be visible. If the output variable has the same name as an input, then its value will overwrite the input variable's value. Thus if you want to view both the input and output values for a completed external activity task, then the parameters should be uniquely named (perhaps using "In" and "Out" postfixes).
taskId
- The task ID of the task to completedocument
- document for addingparentId
- the ID of document which has to be deleted.taskId
- the ID of the task to checkdueDate
- the due date to checkprocessInstanceIds
- the array of process instance IDstaskIds
- the array of task IDsprocessInstanceId
- process instance to get ad hoc starting points fordocumentId
- document IDproperties
- the properties Map [Property Name -> Property Value]
, these properties will be used for documents matching.processAppAcronym
- The acronym of the process applicationprocessSystemId
- The System ID of the process to findprocessInstanceId
- The process instance ID of the process to getprocessInstanceIds
- The process instance IDs of the process instancessavedSearchId
- The saved search ID of the saved search to runroleName
- the user group namescoreboardId
- ID of the scoreboardprocess
- The process to get search meta data fortaskId
- ID of tasksavedSearchId
- The saved search ID of the saved search to runuserName
- user namehelpRequestId
- ID of commentdescription
- description of why request is ignoredtaskId
- the ID of the task to reassigntaskIds
- the IDs of the tasks to reassigntaskIds
- the IDs of the tasks to reassignroleId
- the ID of the roletaskIds
- the IDs of the tasks to reassignuserId
- the ID of the usertaskId
- the ID of the task to reassignroleId
- the ID of the roletaskId
- The task ID of the task to reassignuserId
- The user ID of the userrefreshTimeout
- Time in seconds to complete the operationhelpRequestId
- ID of help request to replydescription
- description of reply to help requestprocessInstanceId
- The process instance ID of the process instance to resumeprocessInstanceIds
- The process instance IDs of the process instances to resumefavoriteI
- dsendTaskInfo
- The information describing the task to sendprocessInstanceId
- process instance for which to start ad hoc starting pointstartingPointName
- ad hoc starting point nameexposedItemI
- dprocess
- The process to startinputs
- The input variables to use when starting the processprocess
- The process to startformId
- The form ID of the InfoPath form to create the form dataformData
- The InfoPath form data to use to start the processStart a task for an activity in a process instance. This requires that the task is not closed and is assigned to the current user or to a role to which the current user belongs. The activity implementation for this task must be an external activity or a service.
An external application should invoke this operation when it actually starts execution of a task. A successful invocation of this operation will record the task's start time using the current user's identity.
taskId
- The task ID of the task to be startedtaskId
- the task IDformData
- the form datataskIds
- the array of task IDsformDatas
- the array of InfoPath form datasprocessInstanceId
- The process instance ID of the process instance to suspendprocessInstanceIds
- The process instance IDs of the process instances to suspendtaskListSyncInputs
- a list of task list synchronization inputsdocument
- document for updatingParent Topic: Web Service API