retrieveChildrenWorkItems

Edit online

The retrieveChildrenWorkItems task retrieves all of the descendent work items for one or more parent work items that you provide as input. This task assigns a String value to an output property, as a list of work items separated by semicolons, containing the full set of parents and their descendant work items. This Ant task can be run prior to the requestPackage task, which is equivalent to selecting the Include children of selected work items check box during a request to create a package for a specified packaging definition.

The following table contains retrieveChildrenWorkItems task attributes.

Attribute	Description	Required
repositoryAddress	Address of the team repository to use. The value of this attribute is typically ${repositoryAddress} because that property is built-in when the Jazz® Build Engine is used.	Yes
userId	User ID for authentication to the repository. Requires password or passwordFile to be set.	Yes
certificateFile	The path to the file that contains the user's login certificate for authentication. Requires password or passwordFile to be set. You can specify certificateFile or repositoriesFile, but not both.	No
outputWorkItemsProperty	Specifies the name of an Ant property that receives a String value, listing the output work item IDs for all parent and descendant work items, separated by semicolon (;). You can specify this attribute, the outputWorkItemsUUIDsProperty attribute, or both.	No
outputWorkItemsUUIDsProperty	Specifies the name of an Ant property that receives a String value, listing the output work item UUIDs for all parent and descendant work items, separated by semicolon (;). You can specify this attribute, the outputWorkItemsProperty attribute, or both.	No
integratedWindows	Whether to use Integrated Windows Authentication	No
kerberos	Whether to use Windows user credentials using Kerberos/SPNeGO.	No
password	Password for the user ID for authentication to the repository. Either password or passwordFile can be provided, but not both.	No
passwordFile	The password file to use for authentication to the connection. You can create a suitable password file by invoking the Jazz Build Engine with the `-createPasswordFile` argument. Only one password file can be specified. Either password or passwordFile can be provided, but not both.	No
parentWorkItems	A semicolon-separated list of work item IDs for parent work items for which children work items are to be retrieved. For example, 1;3;9. This attribute can be specified as an alternative to attribute parentWorkItemUUIDs, but both attributes cannot be specified in the same request.	No
parentWorkItemUUIDs	A semicolon-separated list of work item UUIDs representing work item IDs for parent work items for which children work items are to be retrieved. For example, `_foCQICVGEeOHfOSnPPJHVA;_oqvgoCSfEeOFz9UXwxp0Kw`. This attribute can be specified as an alternative to attribute parentWorkItems, but both attributes cannot be specified in the same request.	No
reuseLoginOption	The first time an Ant task logs in to a repository, a connection is not terminated at the end of this task. All subsequent tasks reuse this connection as long as they connect to same repository with same user ID. When a task logs in to a different repository or with a different user ID, the previous connection is terminated and a new connection is created and reused.	No
repositoriesFile	The repositories registry file that contains a list of repositories and their login credentials. You can specify repositoriesFile or certificateFile, but not both. If you specify repositoriesFile, do not specify either password or passwordFile. The repositories file is created and updated through the use of scm login and logout commands.	No

Example

<retrieveChildrenWorkItems repositoryAddress="${repositoryAddress}"
		                  userId="${userId}"
		                  password="${password}"
		                  parentWorkItems="${parentWorkItems}"
		                  outputWorkItemUUIDsProperty="${outputWorkItemUUIDs}"
		                  outputWorkItemsProperty="${outputWorkItems}"/>