Designing and Implementing Business Process Models 10.4 | Designing and Implementing Business Process Models | Task Engine API and Service Reference | Using the Task Engine RESTful Web Services in My webMethods Server | Summary of REST Resources and Requests Through My webMethods Server
 
Summary of REST Resources and Requests Through My webMethods Server
 
DELETE a Task Instance
GET Task Instance Information
POST a New Task Instance
PUT Information in a Task Instance
GET Tasks with a Simple Search Request
POST a Complex Task Search Request
GET Task Audit Information
DELETE Audit Entries to Rollback Task
GET or POST a Form Flow Notification
DELETE Task Comment
GET Task Comments
PUT Updates into a Task Comment
POST Task Comment
DELETE Task Attachment
GET Task Attachments
PUT Task Attachment
POST Task Attachment
My webMethods Server provides REST requests that can be applied to the following Task Engine resources:
Task Instances
Request
Description
Deletes an instance of a task on the Task Engine.
Returns the TaskInfo object, and optionally the TaskData object, for a specified task.
Creates a new task instance and adds it to the Task Engine queue.
Modifies a task instance on the Task Engines.
Retrieves tasks that match simple search criteria.
Retrieves tasks that are specified with more complex search criteria.
Task Audit Information
Request
Description
Returns the audit log of all of the operations performed on a task, or a specific audit entry.
Enables you to roll back the task to any available audit point in the task's audit history.
Notifies a waiting step in a task workflow that the workflow is completed.
Task Comments
Request
Description
Deletes the specified task comment from a task instance as well as all associated attachments.
Returns either a specific comment or all the comments in a task instance including associated attachments.
Updates a comment in a task instance, including attachments associated with the comment.
Adds a comment to a task instance. Attachments can be included.
Task Attachments
Request
Description
Deletes the specified task attachment from a task instance.
Returns all the attachments in a task instance.
Updates the specified task attachment in a task instance.
Adds the specified attachment to a task instance.
Examples
*To retrieve the details of a task instance with ID 7565, make the following REST call to the Task Engine through the My webMethods Server running on the local machine:
GET /rest/pub/opentask?taskID=7565
*To post a JSON document as task attachment:
POST /rest/pub/opentask/taskID/attachments
Sample JSON document Content:
{"attachment":[{"name":"test_comment_attach","base64Data":
"VGhpcyBpcyBhIGxvbmcgY29tbWVudCBmb3JtIG1lIGZyb20gdGhlIHRleHQgZmlsZQ==",
"contentType":"text/plain"}]}

Copyright © 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release