wm.tn.route:getTask

wm.tn.route:getTask

Retrieves a specified task that is associated with this server (the server on which the wm.tn.route:getTask service is being executed).

Input Parameters

taskID	String The internal unique identifier of the task that you want to retrieve.
includeBizDocErrors	String Prevents the Envelope (see wm.tn.rec:BizDocEnvelope) associated with the task from having the Errors ( wm.tn.rec:BizDocErrorSet) field populated with Activity Log error messages. Valid values are: true - Default. Envelope is loaded with errors from the Activity Log. false - Envelope is not loaded with errors from the Activity Log.

Output Parameters

task	Document The task identified by taskID that the service retrieves. For the structure of task, see wm.tn.rec:Task.

Usage Notes

If taskID is not valid, the service throws an exception.

Each task is associated with a single server, so taskID must be associated with the same server on which the task was started.

To get a task that was started on another server, see the wm.tn.route:getAnyTask service.

If you do not need errors in Envelope, set the includeBizDocErrors parameter to false to decrease the retrieval time and memory usage.