WebSphere Process Server, Version 6.2.0.1
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS
GET /v1/taskTemplate/{tktid}
None.
None.
The default content-type is application/json.
{ "description": "HTM Task Template", "type": "object", "properties": { "applicationDefaultsID": {"type": "string", "description": "ID of the application component that specifies the defaults for tasks derived from this template." }, "applicationName": {"type": "string", "description": "Name of the application the task template is part of." }, "autoDeletionMode": {"type": "string", "description": "States whether an instance derived from the task template is automatically or conditionally deleted when it reaches an end execution state." }, "autonomy": {"type": "string", "description": "States for standalone tasks whether an instance of the task template runs dependently of a potential parent or not.", "enum": [ "AUTONOMY_CHILD", "AUTONOMY_PEER", "AUTONOMY_NOT_APPLICABLE" ] }, "calendarName": {"type": "string", "description": "Name of the calendar used, for example, for expiration calculations." }, "clientTypes": {"type": ["string"], "description": "" }, "containmentContextID": {"type": "string", "description": "ID of the context the task template belongs to." }, "contextAuthorizationOfOwner": {"type": "string", "description": "Authorization rights of owners of tasks that are derived from this template to the associated context." }, "customProperties": {"type": "object", "additionalProperties": {"type": "string"}, "description": "List of cutom property names and values." }, "definitionName": {"type": "string", "description": "Name of the task template definition in the TEL." }, "definitionNamespace": {"type": "string", "description": "XML Schema namespace of the task template definition in the TEL." }, "description": {"type": "string", "description": "Description of the task template." }, "displayName": {"type": "string", "description": "Display name of the task template." }, "durationUntilDeleted": {"type": "string", "description": "Duration that task instances derived from this template are kept after they have reached an end state." }, "durationUntilDue": {"type": "string", "description": "Duration when tasks derived from this template become due." }, "durationUntilExpires": {"type": "string", "description": "Duration when tasks derived from this template expire once they are activated." }, "eventHandlerName": {"type": "string", "description": "Name of the associated event handler." }, "isAdHoc": {"type": "boolean", "description": "States whether the task template has been created ad-hoc." }, "isBusinessRelevant": {"type": "boolean", "description": "States whether a task derived from this template is a business relevant or an 'auxiliary' step." }, "isInline": {"type": "boolean", "description": "States whether the task template describes an inline task or not." }, "jndiNameOfCalendar": {"type": "string", "description": "JNDI name of a user-defined calendar." }, "jndiNameOfStaffPluginProvider": {"type": "string", "description": "JNDI name of a user-defined people directory configuration." }, "kind": {"type": "string", "description": "Kind of tasks derived from this template." }, "name": {"type": "string", "description": "Name of the task template." }, "namespace": {"type": "string", "description": "Namespace that categorizes the task template." }, "priority": {"type": "integer", "description": "Priority of tasks derived from this template." }, "priorityDefinition": {"type": "string", "description": "Priority definition for tasks derived from this template." }, "state": {"type": "string", "description": "States whether the task template is started or stopped." }, "substitutionPolicy": {"type": "string", "description": "Substitution policy that takes place when people assignments are performed for tasks derived from this task template." }, "supportsAutomaticClaim": {"type": "boolean", "description": "States whether a task derived from this template is claimed automatically when it becomes ready." }, "supportsClaimIfSuspended": {"type": "boolean", "description": "States whether tasks derived from this template can be claimed even if they are suspended." }, "supportsDelegation": {"type": "boolean", "description": "States whether tasks derived from this template support delegation, for example, by transferring work items." }, "supportsFollowOnTasks": {"type": "boolean", "description": "States whether tasks derived from this template support the creation of follow-on tasks." }, "supportsSubTasks": {"type": "boolean", "description": "States whether tasks derived from this template support the creation of subtasks." }, "tktid": {"type": "string", "description": "Task template ID." }, "type": {"type": "string", "description": "Type of the task template." }, "validFromTime": {"type": "string", "format": "date-time", "description": "Time the task template became or becomes valid." } } }
The default content-type is application/json.
{ "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." } } }
Code | Description |
---|---|
200 OK | Success completion. |
400 Bad Request | The parameters are not valid or they are missing. |
401 Unauthorized | The caller is not authorized for this request. |
404 Not Found | The task template does not exist.
|
500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
Release | Description |
---|---|
6.2 | The returned human task template object contains a new property:
|
6.1.2
Parent Topic: Task Template Resource