Using the Task Engine RESTful Web Services in Integration Server
Overview
The WmTaskClient package contains RESTful web services that you can use in conjunction with the REST service capabilities of Integration Server. For more information about REST services in general, and about implementing the REST services in Integration Server, see the IBM PDF publication REST Developer’s Guide. Prior to implementing these RESTful web services, you should have a working knowledge of JavaScript Object Notation (JSON).
For more information about working with Integration Server services in general, see the IBM webMethods Service Development Help in Designer.
The Task Engine RESTful web services share data structures (documents) with the Task Engine built-in services. Information about the data structures referred to in the RESTful web service reference topics can be found in the Summary of Data Structures.
In addition to the parameters shown in the RESTful web service reference topics in this section, the Task Engine RESTful web services can also be implemented with parameters from any of the underlying built-in services. These parameters can be specified as key-value pairs in the RESTful web service URL, or as part of an associated JSON document.
Summary of REST Resources and Requests
The IBM webMethods BPM Task Engine API provides REST requests that can be applied to the following Task Engine resources:
Task Instances
| Request | Description |
|---|---|
| DELETE a Task Instance | Deletes an instance of a task on the Task Engine connected to the Integration Server. |
| GET Task Instance Information | Returns the TaskInfo object, and optionally the TaskData object, for one task, or for a list of the TaskData objects (and TaskInfo objects, if specified) for all the tasks the user has permission to access. |
| POST a New Task Instance | Creates a new task instance and adds it to the Task Engine queue. |
| PUT Information in a Task Instance | Modifies a task instance on the Task Engine connected to the Integration Server. |
| GET Tasks with a Simple Search Request | Retrieves tasks that match simple search criteria. |
| POST a Complex Task Search Request | Retrieves tasks that are specified with more complex search criteria. |
Task Audit Information
| GET Task Audit Information | Returns the audit log of all of the operations performed on a task, or a specific audit entry. |
| DELETE Audit Entries to Rollback Task | Enables you to roll back the task to any available audit point in the task's audit history. |
| GET or POST a Form Flow Notification | Notifies a waiting step in a task workflow that the workflow is completed. |
Task Comments
| Request | Description |
|---|---|
| DELETE Task Comment | Deletes the specified task comment from a task instance as well as all associated attachments. |
| GET Task Comments | Returns either a specific comment or all the comments in a task instance including associated attachments. |
| PUT Updates into a Task Comment | Updates a comment in a task instance, including attachments associated with the comment. |
| POST Task Comment | Adds a comment to a task instance. Attachments can be included. |
Task Tags
| Request | Description |
|---|---|
| DELETE Tags From Task | Deletes all tags associated with a taskID. |
| GET Tags By Task | Returns a list of tags associated with a taskID. |
| GET Task Expert List | Returns a list of experts associated with the specified tags. |
| POST Tags To Task | Adds specified tags to a taskID. |
| PUT Task Tags | Updates tags associated with a taskID. |
Task Attachments
| Request | Description |
|---|---|
| DELETE Task Attachment | Deletes the specified task attachment from a task instance. |
| GET Task Attachments | Returns all the attachments in a task instance. |
| PUT Task Attachment | Updates the specified task attachment in a task instance. |
| POST Task Attachment | Adds the specified attachment to a task instance. |