Work Item Attributes
Name Description Required Fetch Attributes Optional Fetch Attributes
all Returns all work item attribute values in a single JSON formatted string. property All options listed for individual attributes may be specified.
approvals Returns work item approvals information. property approvalList
approvalMap

approvalsApprover
approvalsArray
approvalsCumState
approvalsDueDate
approvalsJson
approvalsName
approvalsState
approvalsType

Format of lists:
csv
json

Format of approvalsApprover:
email
userid
username

Format of approvalsDueDate:
date
dateTime
dateLong
time
archived Returns a true/false value for work item archived state. property  
attachment Returns the full file path name of the retrieved attachment. attachmentFile
attachmentId
property
 
category Returns the work item category (Filed Against) value. property  
comments Returns the work item comments. property commentsArray
commentsAuthor
commentsDate
commentsJson
commentsText

Format of lists:
csv
json
contextId Returns the work item restricted access group name or project area name if an access group is not defined for the work item. property  
correctedEstimate Returns the work item corrected estimate. property msecs
units
createdBy Returns the work item creator. property email
userid
username
creationDate Returns the work item creation date. property date
dateTime
dateLong
time
creator Returns the work item creator. property email
userid
username
custom Returns the work item custom attribute value. custom
property
All options applicable to the attribute type may be specified.
customBoolean Returns the work item custom attribute value. custom
property
 
customCategory Returns the work item custom attribute value. custom
property
 
customContributor Returns the work item custom attribute value. custom
property
email
userid
username
customContributorList Returns the work item custom attribute value. custom
property
csv
json
email
userid
username
customDate Returns the work item custom attribute value. custom
property
date
dateTime
dateLong
time
customDecimal Returns the work item custom attribute value. custom
property
 
customDeliverable Returns the work item custom attribute value. custom
property
 
customDuration Returns the work item custom attribute value. custom
property
msecs
units
customEnumeration Returns the work item custom attribute value. custom
property
id
label
customEnumerationList Returns the work item custom attribute value. custom
property
csv
json
id
label
customHtml Returns the work item custom attribute value. custom
property
 
customInteger Returns the work item custom attribute value. custom
property
 
customItem Returns the work item custom attribute value. custom
property
 
customItemList Returns the work item custom attribute value. custom
property
csv
json
customIteration Returns the work item custom attribute value. custom
property
 
customLong Returns the work item custom attribute value. custom
property
 
customProcessArea Returns the work item custom attribute value. custom
property
 
customProcessAreaList Returns the work item custom attribute value. custom
property
csv
json
customProjectArea Returns the work item custom attribute value. custom
property
 
customProjectAreaList Returns the work item custom attribute value. custom
property
csv
json
customString Returns the work item custom attribute value. custom
property
 
customStringList Returns the work item custom attribute value. custom
property
csv
json
customTags Returns the work item custom attribute value. custom
property
csv
json
customTeamArea Returns the work item custom attribute value. custom
property
 
customTeamAreaList Returns the work item custom attribute value. custom
property
csv
json
customTimeline Returns the work item custom attribute value. custom
property
 
customTimestamp Returns the work item custom attribute value. custom
property
date
dateTime
dateLong
time
customWiki Returns the work item custom attribute value. custom
property
 
customWorkItem Returns the work item custom attribute value. custom
property
 
customWorkItemList Returns the work item custom attribute value. custom
property
csv
json
description Returns the work item description. property plainText
xmlText
dueDate Returns the work item due date. property date
dateTime
dateLong
time
duration Returns the work item estimate. property msecs
units
estimate Returns the work item estimate. property msecs
units
filedAgainst Returns the work item category (Filed Against) value. property  
foundIn Returns the work item deliverable. property  
links Returns the work item links. property linkArray
linkComment
linkEndPoint
linkJson
linkType

Format of lists:
csv
json
modified Returns the work item last modified date. property date
dateTime
dateLong
time
modifiedBy Returns the work item modifier. property email
userid
username
modifiedDate Returns the work item last modified date. property date
dateTime
dateLong
time
ownedBy Returns the work item owner. property email
userid
username
owner Returns the work item owner. property email
userid
username
plannedFor Returns the work item target iteration. property  
plannedForEnd Returns the work item target iteration end date. property date
dateTime
dateLong
time
plannedForStart Returns the work item target iteration start date. property date
dateTime
dateLong
time
priority Returns the work item priority. property id
label
projectArea Returns the work item project area. property  
resolution Returns the work item resolution state. property id
label
resolutionDate Returns the work item resolution date. property date
dateTime
dateLong
time
resolvedBy Returns the work item resolver. property email
userid
username
resolver Returns the work item resolver. property email
userid
username
restrictedAccess Returns the work item restricted access group name or project area name if an access group is not defined for the work item. property  
severity Returns the work item severity. property id
label
startDate Returns the work item start date. property date
dateTime
dateLong
time
state Returns the work item state. property id
label
status Returns the work item state. property id
label
subscriptions Returns the work item subscribers. property csv
json
email
userid
username
summary Returns the work item summary. property plainText
xmlText
tag Returns the work item’s first tag. property  
tags Returns the work item tags. property csv
json
target Returns the work item target iteration. property
targetEnd Returns the work item target iteration end date. property date
dateTime
dateLong
time
targetStart Returns the work item target iteration start date. property date
dateTime
dateLong
time
teamArea Returns the work item team area. property  
timeSpent Returns the work item time spent. property msecs
units
type Returns the work item property typeId
typeName