Summary of REST Resources and Requests

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 Integration Server | Summary of REST Resources and Requests

Summary of REST Resources and Requests

The webMethods 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.

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