getTask
- Description
- This transaction retrieves the recorded details of a specific task, including task comments.
- Web Services
- Operation name: getTask
- Example
- Retrieve the basic information of a given task and its entity
association.
Retrieve all the task comments of a specific task.
- Usage information
- There are two inquiry levels for this transaction.
- Preconditions
- Not applicable
- Mandatory input
- TaskId
- InquiryLevel
- Inquiry levels
- InquiryLevel:
- Level 0 – returns the latest updated version of a given task instance and the instancePK of any associated entities.
- Level 1 – returns the level 0 data plus all recorded task comments related to the given task instance.
Attention: If the InquiryLevel is provided, but is empty, then level 0 data will be returned by default. - Filter values
- Not applicable
- Transaction behavior
- Entity descriptions are not returned.
All task comments, whether they are related to specific task actions or not, are returned with the task details.
- Request message
- <InquiryType> getTask
<InquiryParam>
<tcrmParam name = "TaskId">
<tcrmParam name = "InquiryLevel">
- Response objects
- Task details based on the InquiryLevel value:
- 0 - TaskBObj and WorkbasketBObj with a list of WorkbasketEntityBObj, where applicable.
- 1 - Level 0 data plus a list of TaskCommentBObj
- Special note
- Not applicable