Subtasks

Description

The Subtasks type holds information about a subtask relationship. The Subtasks type is used only for informational purposes in the TTItem response. The Subtasks type parameters are listed below.

Parameters

Name Type Description
parentItemId ItemIdentifier Identifies the parent item.
subtask ItemIdentifier Identifies the subtask item.
extendedData ExtendedData Placeholder for future arguments.

Usage

The Subtasks type contains the parent and child items that exist in a subtask relationship. The Subtasks type is returned in the TTItem response to inform you about subtask relationships on returned items. The Subtasks argument is left empty in the CreatePrimaryItems, CreateAuxiliaryItems, and TransitionItems calls. Instead, you must use the LinkSubtask call to create subtask relationships between items.

XML

The following XML shows the parent and subtask items in the <ae:subtasks> parameter of two separate TTItem responses. In this example, a subtask relationship was created using the LinkSubtask call, followed by a GetItems call against each item in the relationship.

GetItems against the parent item (where the TS_ID of the parent is 74) returns:

<ae:subtasks>
   <ae:subtask xsi:type="ae:ItemIdentifier">
      <ae:displayName>HRD000196</ae:displayName>
      <ae:id>75</ae:id>
      <ae:uuid>79e8af21-760d-44a4-af84-aec56935f88f</ae:uuid>
      <ae:tableId>1002</ae:tableId>
      <ae:tableIdItemId>1002:75</ae:tableIdItemId>
      <ae:issueId>000196</ae:issueId>
   </ae:subtask>
</ae:subtasks>

GetItems against the child item (where the TS_ID of the child is 75) returns:

<ae:subtasks>
   <ae:parentItemId xsi:type="ae:ItemIdentifier">
      <ae:displayName>HRD000195</ae:displayName>
      <ae:id>74</ae:id>
      <ae:uuid>5bf6642c-da90-436a-9fd6-2ec06363cdd0</ae:uuid>
      <ae:tableId>1002</ae:tableId>
      <ae:tableIdItemId>1002:74</ae:tableIdItemId>
      <ae:issueId>000195</ae:issueId>
   </ae:parentItemId>
</ae:subtasks>