GET /rest/bpm/htm/v1/taskTemplate/{tktid}None
None
The default content-type is application/json.
{ "description": "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."
},
"assignmentType": {"type": "string",
"description": "States whether the task can be assigned to a single person only or to multiple persons in parallel.",
"enum":
[
"ASSIGNMENT_TYPE_SINGLE",
"ASSIGNMENT_TYPE_PARALLEL"
]
},
"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": "A user-defined client type to specify UI client information, for example, Web, Portal, or Custom."
},
"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."
},
"customText1": {"type": "string",
"description": "Inline custom property 1."
},
"customText2": {"type": "string",
"description": "Inline custom property 2."
},
"customText3": {"type": "string",
"description": "Inline custom property 3."
},
"customText4": {"type": "string",
"description": "Inline custom property 4."
},
"customText5": {"type": "string",
"description": "Inline custom property 5."
},
"customText6": {"type": "string",
"description": "Inline custom property 6."
},
"customText7": {"type": "string",
"description": "Inline custom property 7."
},
"customText8": {"type": "string",
"description": "Inline custom property 8."
},
"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."
},
"isTip": {"type": "boolean", "optional": true,
"description": "States whether the task template is part of a tip."
},
"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."
},
"processAppAcronym": {"type": "string",
"description": "Process application acronym."
},
"processAppName": {"type": "string",
"description": "Process application name."
},
"snapshotID": {"type": "string",
"description": "Snapshot ID of the process application or top-level toolkit."
},
"snapshotName": {"type": "string",
"description": "Snapshot name of the process application or top-level toolkit."
},
"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."
},
"toolkitAcronym": {"type": "string",
"description": "Toolkit acronym."
},
"toolkitName": {"type": "string",
"description": "Toolkit name."
},
"toolkitSnapshotID": {"type": "string",
"description": "Toolkit snapshot ID."
},
"toolkitSnapshotName": {"type": "string",
"description": "Toolkit snapshot name."
},
"topLevelToolkitAcronym": {"type": "string",
"description": "Top-level toolkit acronym."
},
"topLevelToolkitName": {"type": "string",
"description": "Top-level toolkit name."
},
"trackName": {"type": "string",
"description": "Track name."
},
"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": "Error Response",
"type": "object",
"properties":
{ "errorNumber": {"type": "string",
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string",
"description": "Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description":"Message text parameters 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.
|
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 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:
|
| 7.0 | The returned human task template object contains a new property:
|
| 7.5 | The returned human task template object contains new properties:
|
| 7.5.1 | The returned human task template object contains new properties:
|
6.1.2
Parent topic: Task Template Resource