Optional Fetch Element Attributes
Name Value Description
approvalList true/false Approval information is returned in list format.
approvalMap true/false Approval information is grouped by name, and then, returned in list format.
approvalsApprover true/false Return a list of approval approvers.
approvalsArray true/false

Return all approval data in a property array. Each approval is returned in one element of the array. The array is indexed starting with 1. The total number of elements is returned in the property specified. The property name specified is used as the prefix for all properties created for the array. The property array has the following format:

Array Property Value
1 propertyName.approver.n Approval approver name.
2 propertyName.cumstate.n Approval cumulative state.
3 propertyName.duedate.n Approval due date.
4 propertyName.name.n Approval name.
5 propertyName.state.n Approval state.
6 propertyName.type.n Approval type.
approvalsCumState true/false Return a list of approval cumulative states.
approvalsDueDate true/false Return a list of approval due dates.
approvalsJson true/false

Return all approval data in JSON format. If the approvalList option is used, a JSON object is created for each approval. The name of the object is an index value which starts at 1. The value of the object is another JSON object with 6 elements:

Name Value
1 approver Approval approver name.
2 cumstate Approval cumulative state.
3 duedate Approval due date.
4 name Approval name.
5 state Approval state.
6 type Approval type.

If the approvalMap option is used, an element in a JSON object is created for each named group. The name of the element is the group name. The value of the element is a JSON array. The value of each element in the array is a JSON object with 5 elements:

Name Value
1 approver Approval approver name.
2 cumstate Approval cumulative state.
3 duedate Approval due date.
4 state Approval state.
5 type Approval type.
approvalsName true/false Return a list of approval names.
approvalsState true/false Return a list of approval states.
approvalsType true/false Return a list of approval types.
commentsArray true/false

Return all comment data in a property array. Each comment is returned in one element of the array. The array is indexed starting with 1. The total number of elements is returned in the property specified. The property name specified is used as the prefix for all properties created for the array. The property array has the following format:

Array Property Value
1 propertyName.author.n Comment author.
2 propertyName.date.n Comment date.
3 propertyName.text.n Comment text.
commentsAuthor true/false Return a list of comment authors.
commentsDate true/false Return a list of comment dates.
commentsJson true/false

Return all comment data in JSON format. Each comment is added to the JSON object as an element. The name of the element is an index value which starts at 1. The value of the element is another JSON object with 3 elements:

Name Value
1 author Comment author.
2 date Comment date.
3 text Comment text.
commentsText true/false Return a list of comment text.
csv true/false Return a list in comma separated value format. Note: Values that may contain commas are double quoted with internal double quotes escaped.
date true/false Return the date in yyyy-MM-dd format.
dateTime true/false Return the date in yyyy-MM-dd hh:mm:ss format.
dateLong true/false Return the date in yyyy-MM-dd hh:mm:ss.SSS format.
email true/false Return the userid in email format.
id true/false Return an enumeration value in id format.
json true/false Return a list in JSON array format.
label true/false Return an enumeration value in label format.
linkArray true/false

Return all link data in a property array. Each link is returned in one element of the array. The array is indexed starting with 1. The total number of elements is returned in the property specified. The property name specified is used as the prefix for all properties created for the array. The property array has the following format:

Array Property Value
1 propertyName.comment.n Link comment.
2 propertyName.endpoint.n Link endpoint.
3 propertyName.linktype.n Link type.
linkComment true/false Return a list of link comments.
linkEndPoint true/false Return a list of link endpoints.
linkJson true/false

Return all links data in JSON format. Each link endpoint group is added to a JSON object as an element. The name of the element is the endpoint group name. The value of the element is a JSON array. The value of each element in the array is a JSON object with 3 elements:

Name Value
1 comment Link comment.
2 endpoint End point.
3 linktype Link type.
linkType true/false Return a list of link types.
msecs true/false Return a duration in milliseconds format.
plainText true/false Return a text value in plain text format.
time true/false Return the date in hh:mm:ss format.
typeId true/false Return the work item ID.
typeName true/false Return the work item display name.
units true/false Return a duration in units (1d, 1h, 1m) format.
userid true/false Return the userid in userid format.
username true/false Return the userid in name format.
xmlText true/false Return a text value in XML text format.