Work Item Attributes
Name Description Required Store Attributes Optional Store Attributes
action Request a work flow action for the work item. Work item actions are defined in the process definition work flow for the work item. Specify an action label or an action ID.

Action labels are displayed in the Eclipse client. For example: one of the action labels for a Task in "New" state is "Start Working".

An action ID is the identifier for the action which can be found in the process definition. For example: the ID for the Task "Start Working" label is:

com.ibm.team.workitem.taskWorkflow.action.startWorking

The action specified must be one of the valid actions for the current work item state.

value id
label
approval Adds an approval entry to the work item. Specify an approval name. The approval type is specified with the approvalType attribute. An approval type is also required. Other approval information can be specified with the optional attributes: approvalDueDate for due date and approvalApprover for the userid of the approver. value
approvalType
approvalApprover
approvalDueDate
include
remove
attachment Specify the full path to the name of a local file to attach to the work item. For example:
value="D:/rtc/Builds/PI37999.Regtest.Work items included in build.html"

Content encoding defaults to UTF8. Content type defaults to "text".

value contentEncoding
contentType
category Specify the full path name to a category defined to the work item’s project. Categories and sub-categories are separated by forward slashes: Category/Sub-category. value  
comments Specify comment text in the designated form. To specify links or text formatting use the xmlText option. value plainText
xmlText
contextId Specify the name of an access group or project area to restrict access to the work item. value  
correctedEstimate Specify the corrected estimate in duration format. value msecs
units
custom Specify a custom attribute id and value. custom
value
All options applicable to the attribute type may be specified.
customBoolean Specify true or false. custom
value
 
customCategory Specify a category. custom
value
projectArea
customContributor Specify a userid. custom
value
email
username
userid
customContributorList Specify a userid. custom
value
email
username
userid
include
remove
customDate Specify a date. custom
value
date
dateTime
dateLong
customDecimal Specify a decimal value. custom
value
CustomDeliverable Specify a deliverable name value. custom
value
projectArea
CustomDuration Specify a duration value. custom
value
msecs
units
customEnumeration Specify the id or label of a custom enumeration. custom
value
id
label
projectArea
customEnumerationList Specify the id or label of a custom enumeration. custom
value
id
label
include
remove
projectArea
customHtml Specify HTML formatted text. Note: The HTML formatted text can be added with the value attribute or as free form text between start <store ...> and end </store> tags. If free form text is specified, the value attribute is not required. custom
value
customInteger Specify an integer value. custom
value
customItem Specify an item and and type. An item can be removed by specifying value="". custom
value
itemCategory
itemComponent
itemContributor
itemDeliverable
itemIteration
itemProcessArea
itemProjectArea
itemTeamArea
itemWorkItem
projectArea
customItemList Specify an item and and type. custom
value
itemCategory
itemComponent
itemContributor
itemDeliverable
itemIteration
itemProcessArea
itemProjectArea
itemTeamArea
itemWorkItem
include
remove
projectArea
customIteration Specify an iteration name. custom
value
projectArea
customLong Specify a long integer value. custom
value
customProcessArea Specify the name of a process area defined to EWM. A process area can be removed by specifying value="". custom
value
customProcessAreaList Specify the name of a process area defined to EWM. custom
value
include
remove
customProjectArea Specify the name of a project area defined to EWM. A project area can be removed by specifying value="". custom
value
customProjectAreaList Specify the name of a project area defined to EWM. custom
value
include
remove
customString Specify a string value. custom
value
customStringList Specify a string value. custom
value
include
remove
customTags Specify a tag string. Multiple tags can be specified in the string by separating each with a comma: "tag1,tag2,tag3". Tags can be removed using the replace option. All tags can be removed by specifying "" and replace="true". custom
value
add
replace
customTeamArea Specify a team area name value. custom
value
customTeamAreaList Specify a team area name value. custom
value
include
remove
customTimestamp Specify a date. custom
value
date
dateTime
dateLong
customWiki Specify wiki formatted text. Note: The wiki formatted text can be added with the value attribute or as free form text between start <store ...> and end </store> tags. If free form text is specified, the value attribute is not required. custom
value
customWorkItem Specify a work item id value. A work item can be removed by specifying value="". custom
value
customWorkItemList Specify a work item id value. custom
value
include
remove
description Description text in the specified form. To specify links or text formatting options use the xmlText option. value plainText
xmlText
dueDate Specify the due date. value date
dateTime
dateLong
duration Specify a duration estimate. value msecs
units
estimate Specify a duration estimate. This is a synonym for the duration attribute. value msecs
units
filedAgainst Specify the full path name to a category defined to the project. Categories and sub-categories are separated by forward slashes: Category/Sub-category. This is a synonym for the category attribute. value
foundIn Specify a deliverable that is defined to the project. Deliverables are defined on the project area in the project area Releases tab. value
link Specify the id or UUID of the item to link and the type of link to create. A link type is required. linkType
value
modified Specify the modify date. value date
dateTime
dateLong
modifiedBy Specify the userid of the modifier. value email
username
userid
modifiedDate Specify the modify date. This is a synonym for the modified attribute. value date
dateTime
dateLong
ownedBy Specify the userid of the owner. This is a synonym for the owner attribute. value email
username
userid
owner Specify the userid of the owner. value email
username
userid
plannedFor Specify the name of the target iteration. This is a synonym for the target attribute. value  
userid
priority Specify the id or label of a priority enumeration. value id
label
resolution Specify the work item resolution. Work item resolutions are defined in the process definition work flow for the work item. Specify an resolution label or an resolution ID.

A resolution label is displayed in the Eclipse client resolution drop down, which is next to the action drop down. For example: one of the resolution labels for a Defect is "Fixed".

A resolution ID is the identifier for the resolution. The ID for the Defect "Fixed" label is "r2", which must be specified as "2". Normally, IDs are fully specified:

com.ibm.team.rtc.workflow.action.resolution.r1

Only the two character primitive IDs need to be reduced to the number alone. A resolution can only be specified for a work item with resolutions defined. The resolution specified must be one of the valid resolutions for the work item.

value id
label
resolutionDate Specify the resolution date. value date
dateTime
dateLong
resolvedBy Specify the userid of the resolver. This is a synonym for the resolver attribute. value email
username
userid
resolver Specify the userid of the resolver. value email
username
userid
restrictedAccess Specify the name of an access group or project area to restrict access to the work item. This is a synonym for the contextId attribute. value
severity Specify the id or label of a severity enumeration. value id
label
startDate Specify the start date for the work item. value date
dateTime
dateLong
subscriber Specify the userid of the subscriber. If include="true" is specified, the userid will be added to the subscriber list. If remove="true" is specified, the userid will be deleted from the subscriber list. value email
username
userid
include
remove
summary Summary text in the specified form. value plainText
xmlText
tags Specify tags for the work item. Multiple tags can be specified in the string, by separating each with a comma: "tag1,tag2,tag3". value add
replace
target Specify the name of the target iteration. value
timeSpent Specify the time spent working on the item. value msecs
units
type Specify the id or label of a new work item type for the work item. value id
label