Task Engine 10.11 | Task Engine Webhelp | webMethods Task Engine API and Service Reference | Using the Task Engine RESTful Web Services in My webMethods Server | POST a New Task Instance
POST a New Task Instance
This REST request creates a new task instance and adds it to the Task Engine queue.
Use this HTTP request and include optional parameters in the request body:
POST /rest/pub/opentask
Input Parameters
Map Optional. The business data, if any, associated with this task. See TaskData for a description of the Map object used by taskData.
TaskInfo Optional. A complex structure that contains standard information about the task (for example, name, expiration date, list of users to which the task is assigned). See TaskInfo for a description of the fields in this object.
String Specifies the type of task that you want to queue. Each task type that is deployed on the Task Engine has a unique ID. This ID is assigned by the developer when he or she creates a task application using Software AG Designer.
If you do not know the ID for the task type that you want to queue, contact the Task Engine administrator. An administrator can obtain a list of the task types by viewing the Task Configuration panel on the Task Engine Administration page in My webMethods.
Task type IDs are case-sensitive. The ID in taskTypeID must exactly match the ID as it is specified on the Task Engine.
String Optional. The user ID of the My webMethods Server user on whose behalf this operation executes.
If user is not specified, the user ID under which your client program logged on is used.
Output Parameters
String The identifier that the Task Engine assigns to the task instance.
Usage Notes
The user ID specified in user must have permission to queue tasks on the Task Engine. If the supplied ID does not have this permission, an exception is generated.
If the date specified in taskScheduleDate is later than the current date, the status of the task will be set to scheduled. When the task starts or queues at the scheduled time, the global rule for task schedule changes the status of the task from scheduled to active.