WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Human Task Manager REST Interface - Task Instance Resource - PUT (Start) Method

Use this method to start a new task using a synchronous (call) or asynchronous (start) operation.

Resource URI

PUT /v1/task/{tkiid}?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
action string
Action to be performed for the specified task.
ValueDescription
start
Start a new task.
mode string
Task start mode.
ValueDescription
sync
Use a synchronous operation to start the task. This value is only allowed for invocation tasks, and it is not allowed if the parameters relation and parentTaskID are specified.
async
Use a asynchronous operation to start the task.
Optional Parameters
NameValue TypeDescription
relation string
Task relationship - must be specified together with the parentTaskID parameter.
ValueDescription
subTask
The new task is a subtask. This value can only be used when the mode parameter is set to async.
parentTaskID string
Task ID of the parent task - must be specified together with the relation parameter.

Request Content

Human task input (optional). The XML Schema for the started task's input, that is, the XML Schema type/element used for the WSDL message part definition, is defined as part of the custom task template definition. Data defined by an XML Schema simple type is wrapped in an XML element provided by this REST interface (see Simple-Typed XML Data).

The default content-type is application/xml.

Response Content

Human task output. Only returned if the task is an invocation task and the mode parameter is set to sync. The XML Schema for the started task's output, that is, the XML Schema type/element used for the WSDL message part definition, is defined as part of the custom task template definition. Data defined by an XML Schema simple type is wrapped in an XML element provided by this REST interface (see Simple-Typed XML Data).

The default content-type is application/xml.

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The task does not exist.
409 ConflictA conflict exists with the current state of the resource.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Change History

The following changes have been applied to this method:
ReleaseDescription
6.2
New parameters have been added to this method in order to allow starting a previously created task as a subtask of another task:
  • "relation"
  • "parentTaskID"

Available Since

6.1.2

Parent Topic: Task Instance Resource