Microsoft.TeamFoundation.WorkItemTracking.WebApi.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.TeamFoundation.WorkItemTracking.WebApi</name> </assembly> <members> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemFieldDictionaryConverter.CanWrite"> <summary> For writing, we don't need anything special, so just do the default serialization </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.ValueArrayConverter.CanWrite"> <summary> For writing, we don't need anything special, so just do the default serialization </summary> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetAccountMyWorkDataAsync(System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryOption},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE. This returns Doing, Done, Follows and activity work items details. </summary> <param name="queryOption"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRecentActivityDataAsync(System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets recent work item activities </summary> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRecentMentionsAsync(System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE. </summary> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkArtifactLinkTypesAsync(System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get the list of work item tracking outbound artifact link types. </summary> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryWorkItemsForArtifactUrisAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ArtifactUriQuery,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Queries work items linked to a given list of artifact URI. </summary> <param name="artifactUriQuery">Defines a list of artifact URI for querying work items.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryWorkItemsForArtifactUrisAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ArtifactUriQuery,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Queries work items linked to a given list of artifact URI. </summary> <param name="artifactUriQuery">Defines a list of artifact URI for querying work items.</param> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryWorkItemsForArtifactUrisAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ArtifactUriQuery,System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Queries work items linked to a given list of artifact URI. </summary> <param name="artifactUriQuery">Defines a list of artifact URI for querying work items.</param> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateAttachmentAsync(System.IO.Stream,System.String,System.String,System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Uploads an attachment. </summary> <param name="uploadStream">Stream to upload</param> <param name="project">Project ID or project name</param> <param name="fileName">The name of the file</param> <param name="uploadType">Attachment upload type: Simple or Chunked</param> <param name="areaPath">Target project Area Path</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateAttachmentAsync(System.IO.Stream,System.Guid,System.String,System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Uploads an attachment. </summary> <param name="uploadStream">Stream to upload</param> <param name="project">Project ID</param> <param name="fileName">The name of the file</param> <param name="uploadType">Attachment upload type: Simple or Chunked</param> <param name="areaPath">Target project Area Path</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateAttachmentAsync(System.IO.Stream,System.String,System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Uploads an attachment. </summary> <param name="uploadStream">Stream to upload</param> <param name="fileName">The name of the file</param> <param name="uploadType">Attachment upload type: Simple or Chunked</param> <param name="areaPath">Target project Area Path</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetAttachmentContentAsync(System.String,System.Guid,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Downloads an attachment. </summary> <param name="project">Project ID or project name</param> <param name="id">Attachment ID</param> <param name="fileName">Name of the file</param> <param name="download">If set to <c>true</c> always download attachment</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetAttachmentContentAsync(System.Guid,System.Guid,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Downloads an attachment. </summary> <param name="project">Project ID</param> <param name="id">Attachment ID</param> <param name="fileName">Name of the file</param> <param name="download">If set to <c>true</c> always download attachment</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetAttachmentContentAsync(System.Guid,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Downloads an attachment. </summary> <param name="id">Attachment ID</param> <param name="fileName">Name of the file</param> <param name="download">If set to <c>true</c> always download attachment</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetAttachmentZipAsync(System.String,System.Guid,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Downloads an attachment. </summary> <param name="project">Project ID or project name</param> <param name="id">Attachment ID</param> <param name="fileName">Name of the file</param> <param name="download">If set to <c>true</c> always download attachment</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetAttachmentZipAsync(System.Guid,System.Guid,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Downloads an attachment. </summary> <param name="project">Project ID</param> <param name="id">Attachment ID</param> <param name="fileName">Name of the file</param> <param name="download">If set to <c>true</c> always download attachment</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetAttachmentZipAsync(System.Guid,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Downloads an attachment. </summary> <param name="id">Attachment ID</param> <param name="fileName">Name of the file</param> <param name="download">If set to <c>true</c> always download attachment</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetClassificationNodesAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Metadata.ClassificationNodesErrorPolicy},System.Object,System.Threading.CancellationToken)"> <summary> Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project. </summary> <param name="project">Project ID or project name</param> <param name="ids">Comma separated integer classification nodes ids. It's not required, if you want root nodes.</param> <param name="depth">Depth of children to fetch.</param> <param name="errorPolicy">Flag to handle errors in getting some nodes. Possible options are Fail and Omit.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetClassificationNodesAsync(System.Guid,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Metadata.ClassificationNodesErrorPolicy},System.Object,System.Threading.CancellationToken)"> <summary> Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project. </summary> <param name="project">Project ID</param> <param name="ids">Comma separated integer classification nodes ids. It's not required, if you want root nodes.</param> <param name="depth">Depth of children to fetch.</param> <param name="errorPolicy">Flag to handle errors in getting some nodes. Possible options are Fail and Omit.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRootNodesAsync(System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets root classification nodes under the project. </summary> <param name="project">Project ID or project name</param> <param name="depth">Depth of children to fetch.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRootNodesAsync(System.Guid,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets root classification nodes under the project. </summary> <param name="project">Project ID</param> <param name="depth">Depth of children to fetch.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateOrUpdateClassificationNodeAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode,System.String,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeStructureGroup,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Create new or update an existing classification node. </summary> <param name="postedNode">Node to create or update.</param> <param name="project">Project ID or project name</param> <param name="structureGroup">Structure group of the classification node, area or iteration.</param> <param name="path">Path of the classification node.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateOrUpdateClassificationNodeAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode,System.Guid,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeStructureGroup,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Create new or update an existing classification node. </summary> <param name="postedNode">Node to create or update.</param> <param name="project">Project ID</param> <param name="structureGroup">Structure group of the classification node, area or iteration.</param> <param name="path">Path of the classification node.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteClassificationNodeAsync(System.String,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeStructureGroup,System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Delete an existing classification node. </summary> <param name="project">Project ID or project name</param> <param name="structureGroup">Structure group of the classification node, area or iteration.</param> <param name="path">Path of the classification node.</param> <param name="reclassifyId">Id of the target classification node for reclassification.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteClassificationNodeAsync(System.Guid,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeStructureGroup,System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Delete an existing classification node. </summary> <param name="project">Project ID</param> <param name="structureGroup">Structure group of the classification node, area or iteration.</param> <param name="path">Path of the classification node.</param> <param name="reclassifyId">Id of the target classification node for reclassification.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetClassificationNodeAsync(System.String,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeStructureGroup,System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the classification node for a given node path. </summary> <param name="project">Project ID or project name</param> <param name="structureGroup">Structure group of the classification node, area or iteration.</param> <param name="path">Path of the classification node.</param> <param name="depth">Depth of children to fetch.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetClassificationNodeAsync(System.Guid,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeStructureGroup,System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the classification node for a given node path. </summary> <param name="project">Project ID</param> <param name="structureGroup">Structure group of the classification node, area or iteration.</param> <param name="path">Path of the classification node.</param> <param name="depth">Depth of children to fetch.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateClassificationNodeAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode,System.String,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeStructureGroup,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Update an existing classification node. </summary> <param name="postedNode">Node to create or update.</param> <param name="project">Project ID or project name</param> <param name="structureGroup">Structure group of the classification node, area or iteration.</param> <param name="path">Path of the classification node.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateClassificationNodeAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode,System.Guid,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeStructureGroup,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Update an existing classification node. </summary> <param name="postedNode">Node to create or update.</param> <param name="project">Project ID</param> <param name="structureGroup">Structure group of the classification node, area or iteration.</param> <param name="path">Path of the classification node.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetEngagedUsersAsync(System.String,System.Int32,System.Int32,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReactionType,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get users who reacted on the comment. </summary> <param name="project">Project ID or project name</param> <param name="workItemId">WorkItem ID.</param> <param name="commentId">Comment ID.</param> <param name="reactionType">Type of the reaction.</param> <param name="top"></param> <param name="skip"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetEngagedUsersAsync(System.Guid,System.Int32,System.Int32,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReactionType,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get users who reacted on the comment. </summary> <param name="project">Project ID</param> <param name="workItemId">WorkItem ID.</param> <param name="commentId">Comment ID.</param> <param name="reactionType">Type of the reaction.</param> <param name="top"></param> <param name="skip"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.AddCommentAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentCreate,System.String,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Add a comment on a work item. </summary> <param name="request">Comment create request.</param> <param name="project">Project ID or project name</param> <param name="workItemId">Id of a work item.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.AddCommentAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentCreate,System.Guid,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Add a comment on a work item. </summary> <param name="request">Comment create request.</param> <param name="project">Project ID</param> <param name="workItemId">Id of a work item.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteCommentAsync(System.String,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Delete a comment on a work item. </summary> <param name="project">Project ID or project name</param> <param name="workItemId">Id of a work item.</param> <param name="commentId"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteCommentAsync(System.Guid,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Delete a comment on a work item. </summary> <param name="project">Project ID</param> <param name="workItemId">Id of a work item.</param> <param name="commentId"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentAsync(System.String,System.Int32,System.Int32,System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns a work item comment. </summary> <param name="project">Project ID or project name</param> <param name="workItemId">Id of a work item to get the comment.</param> <param name="commentId">Id of the comment to return.</param> <param name="includeDeleted">Specify if the deleted comment should be retrieved.</param> <param name="expand">Specifies the additional data retrieval options for work item comments.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentAsync(System.Guid,System.Int32,System.Int32,System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns a work item comment. </summary> <param name="project">Project ID</param> <param name="workItemId">Id of a work item to get the comment.</param> <param name="commentId">Id of the comment to return.</param> <param name="includeDeleted">Specify if the deleted comment should be retrieved.</param> <param name="expand">Specifies the additional data retrieval options for work item comments.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentsAsync(System.String,System.Int32,System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns a list of work item comments, pageable. </summary> <param name="project">Project ID or project name</param> <param name="workItemId">Id of a work item to get comments for.</param> <param name="top">Max number of comments to return.</param> <param name="continuationToken">Used to query for the next page of comments.</param> <param name="includeDeleted">Specify if the deleted comments should be retrieved.</param> <param name="expand">Specifies the additional data retrieval options for work item comments.</param> <param name="order">Order in which the comments should be returned.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentsAsync(System.Guid,System.Int32,System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns a list of work item comments, pageable. </summary> <param name="project">Project ID</param> <param name="workItemId">Id of a work item to get comments for.</param> <param name="top">Max number of comments to return.</param> <param name="continuationToken">Used to query for the next page of comments.</param> <param name="includeDeleted">Specify if the deleted comments should be retrieved.</param> <param name="expand">Specifies the additional data retrieval options for work item comments.</param> <param name="order">Order in which the comments should be returned.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentsBatchAsync(System.String,System.Int32,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns a list of work item comments by ids. </summary> <param name="project">Project ID or project name</param> <param name="workItemId">Id of a work item to get comments for.</param> <param name="ids">Comma-separated list of comment ids to return.</param> <param name="includeDeleted">Specify if the deleted comments should be retrieved.</param> <param name="expand">Specifies the additional data retrieval options for work item comments.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentsBatchAsync(System.Guid,System.Int32,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns a list of work item comments by ids. </summary> <param name="project">Project ID</param> <param name="workItemId">Id of a work item to get comments for.</param> <param name="ids">Comma-separated list of comment ids to return.</param> <param name="includeDeleted">Specify if the deleted comments should be retrieved.</param> <param name="expand">Specifies the additional data retrieval options for work item comments.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateCommentAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentUpdate,System.String,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Update a comment on a work item. </summary> <param name="request">Comment update request.</param> <param name="project">Project ID or project name</param> <param name="workItemId">Id of a work item.</param> <param name="commentId"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateCommentAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentUpdate,System.Guid,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Update a comment on a work item. </summary> <param name="request">Comment update request.</param> <param name="project">Project ID</param> <param name="workItemId">Id of a work item.</param> <param name="commentId"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateCommentReactionAsync(System.String,System.Int32,System.Int32,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReactionType,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Adds a new reaction to a comment. </summary> <param name="project">Project ID or project name</param> <param name="workItemId">WorkItem ID</param> <param name="commentId">Comment ID</param> <param name="reactionType">Type of the reaction</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateCommentReactionAsync(System.Guid,System.Int32,System.Int32,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReactionType,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Adds a new reaction to a comment. </summary> <param name="project">Project ID</param> <param name="workItemId">WorkItem ID</param> <param name="commentId">Comment ID</param> <param name="reactionType">Type of the reaction</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteCommentReactionAsync(System.String,System.Int32,System.Int32,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReactionType,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Deletes an existing reaction on a comment. </summary> <param name="project">Project ID or project name</param> <param name="workItemId">WorkItem ID</param> <param name="commentId">Comment ID</param> <param name="reactionType">Type of the reaction</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteCommentReactionAsync(System.Guid,System.Int32,System.Int32,Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReactionType,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Deletes an existing reaction on a comment. </summary> <param name="project">Project ID</param> <param name="workItemId">WorkItem ID</param> <param name="commentId">Comment ID</param> <param name="reactionType">Type of the reaction</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentReactionsAsync(System.String,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets reactions of a comment. </summary> <param name="project">Project ID or project name</param> <param name="workItemId">WorkItem ID</param> <param name="commentId">Comment ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentReactionsAsync(System.Guid,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets reactions of a comment. </summary> <param name="project">Project ID</param> <param name="workItemId">WorkItem ID</param> <param name="commentId">Comment ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentVersionAsync(System.String,System.Int32,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="project">Project ID or project name</param> <param name="workItemId"></param> <param name="commentId"></param> <param name="version"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentVersionAsync(System.Guid,System.Int32,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="project">Project ID</param> <param name="workItemId"></param> <param name="commentId"></param> <param name="version"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentVersionsAsync(System.String,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="project">Project ID or project name</param> <param name="workItemId"></param> <param name="commentId"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetCommentVersionsAsync(System.Guid,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="project">Project ID</param> <param name="workItemId"></param> <param name="commentId"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateFieldAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField,System.Object,System.Threading.CancellationToken)"> <summary> Create a new field. </summary> <param name="workItemField">New field definition</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateFieldAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Create a new field. </summary> <param name="workItemField">New field definition</param> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateFieldAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField,System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> Create a new field. </summary> <param name="workItemField">New field definition</param> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteFieldAsync(System.String,System.Object,System.Threading.CancellationToken)"> <summary> Deletes the field. </summary> <param name="fieldNameOrRefName">Field simple name or reference name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteFieldAsync(System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Deletes the field. </summary> <param name="project">Project ID or project name</param> <param name="fieldNameOrRefName">Field simple name or reference name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteFieldAsync(System.Guid,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Deletes the field. </summary> <param name="project">Project ID</param> <param name="fieldNameOrRefName">Field simple name or reference name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetFieldAsync(System.String,System.Object,System.Threading.CancellationToken)"> <summary> Gets information on a specific field. </summary> <param name="fieldNameOrRefName">Field simple name or reference name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetFieldAsync(System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Gets information on a specific field. </summary> <param name="project">Project ID or project name</param> <param name="fieldNameOrRefName">Field simple name or reference name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetFieldAsync(System.Guid,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Gets information on a specific field. </summary> <param name="project">Project ID</param> <param name="fieldNameOrRefName">Field simple name or reference name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetFieldsAsync(System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.GetFieldsExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns information for all fields. </summary> <param name="project">Project ID or project name</param> <param name="expand">Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetFieldsAsync(System.Guid,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.GetFieldsExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns information for all fields. </summary> <param name="project">Project ID</param> <param name="expand">Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetFieldsAsync(System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.GetFieldsExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns information for all fields. </summary> <param name="expand">Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateQueryAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem,System.String,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Creates a query, or moves a query. </summary> <param name="postedQuery">The query to create.</param> <param name="project">Project ID or project name</param> <param name="query">The parent id or path under which the query is to be created.</param> <param name="validateWiqlOnly">If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateQueryAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem,System.Guid,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Creates a query, or moves a query. </summary> <param name="postedQuery">The query to create.</param> <param name="project">Project ID</param> <param name="query">The parent id or path under which the query is to be created.</param> <param name="validateWiqlOnly">If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteQueryAsync(System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder. </summary> <param name="project">Project ID or project name</param> <param name="query">ID or path of the query or folder to delete.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteQueryAsync(System.Guid,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder. </summary> <param name="project">Project ID</param> <param name="query">ID or path of the query or folder to delete.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueriesAsync(System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Gets the root queries and their children </summary> <param name="project">Project ID or project name</param> <param name="expand">Include the query string (wiql), clauses, query result columns, and sort options in the results.</param> <param name="depth">In the folder of queries, return child queries and folders to this depth.</param> <param name="includeDeleted">Include deleted queries and folders</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueriesAsync(System.Guid,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Gets the root queries and their children </summary> <param name="project">Project ID</param> <param name="expand">Include the query string (wiql), clauses, query result columns, and sort options in the results.</param> <param name="depth">In the folder of queries, return child queries and folders to this depth.</param> <param name="includeDeleted">Include deleted queries and folders</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueryAsync(System.String,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Retrieves an individual query and its children </summary> <param name="project">Project ID or project name</param> <param name="query">ID or path of the query.</param> <param name="expand">Include the query string (wiql), clauses, query result columns, and sort options in the results.</param> <param name="depth">In the folder of queries, return child queries and folders to this depth.</param> <param name="includeDeleted">Include deleted queries and folders</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueryAsync(System.Guid,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Retrieves an individual query and its children </summary> <param name="project">Project ID</param> <param name="query">ID or path of the query.</param> <param name="expand">Include the query string (wiql), clauses, query result columns, and sort options in the results.</param> <param name="depth">In the folder of queries, return child queries and folders to this depth.</param> <param name="includeDeleted">Include deleted queries and folders</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.SearchQueriesAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Searches all queries the user has access to in the current project </summary> <param name="project">Project ID or project name</param> <param name="filter">The text to filter the queries with.</param> <param name="top">The number of queries to return (Default is 50 and maximum is 200).</param> <param name="expand"></param> <param name="includeDeleted">Include deleted queries and folders</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.SearchQueriesAsync(System.Guid,System.String,System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Searches all queries the user has access to in the current project </summary> <param name="project">Project ID</param> <param name="filter">The text to filter the queries with.</param> <param name="top">The number of queries to return (Default is 50 and maximum is 200).</param> <param name="expand"></param> <param name="includeDeleted">Include deleted queries and folders</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateQueryAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem,System.String,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Update a query or a folder. This allows you to update, rename and move queries and folders. </summary> <param name="queryUpdate">The query to update.</param> <param name="project">Project ID or project name</param> <param name="query">The ID or path for the query to update.</param> <param name="undeleteDescendants">Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateQueryAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem,System.Guid,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Update a query or a folder. This allows you to update, rename and move queries and folders. </summary> <param name="queryUpdate">The query to update.</param> <param name="project">Project ID</param> <param name="query">The ID or path for the query to update.</param> <param name="undeleteDescendants">Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueriesBatchAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryBatchGetRequest,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Gets a list of queries by ids (Maximum 1000) </summary> <param name="queryGetRequest"></param> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueriesBatchAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryBatchGetRequest,System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> Gets a list of queries by ids (Maximum 1000) </summary> <param name="queryGetRequest"></param> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DestroyWorkItemAsync(System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Destroys the specified work item permanently from the Recycle Bin. This action can not be undone. </summary> <param name="id">ID of the work item to be destroyed permanently</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DestroyWorkItemAsync(System.String,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Destroys the specified work item permanently from the Recycle Bin. This action can not be undone. </summary> <param name="project">Project ID or project name</param> <param name="id">ID of the work item to be destroyed permanently</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DestroyWorkItemAsync(System.Guid,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Destroys the specified work item permanently from the Recycle Bin. This action can not be undone. </summary> <param name="project">Project ID</param> <param name="id">ID of the work item to be destroyed permanently</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetDeletedWorkItemAsync(System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Gets a deleted work item from Recycle Bin. </summary> <param name="id">ID of the work item to be returned</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetDeletedWorkItemAsync(System.String,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Gets a deleted work item from Recycle Bin. </summary> <param name="project">Project ID or project name</param> <param name="id">ID of the work item to be returned</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetDeletedWorkItemAsync(System.Guid,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Gets a deleted work item from Recycle Bin. </summary> <param name="project">Project ID</param> <param name="id">ID of the work item to be returned</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetDeletedWorkItemsAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the work items from the recycle bin, whose IDs have been specified in the parameters </summary> <param name="project">Project ID or project name</param> <param name="ids">Comma separated list of IDs of the deleted work items to be returned</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetDeletedWorkItemsAsync(System.Guid,System.Collections.Generic.IEnumerable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the work items from the recycle bin, whose IDs have been specified in the parameters </summary> <param name="project">Project ID</param> <param name="ids">Comma separated list of IDs of the deleted work items to be returned</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetDeletedWorkItemsAsync(System.Collections.Generic.IEnumerable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the work items from the recycle bin, whose IDs have been specified in the parameters </summary> <param name="ids">Comma separated list of IDs of the deleted work items to be returned</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetDeletedWorkItemShallowReferencesAsync(System.Object,System.Threading.CancellationToken)"> <summary> Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin. </summary> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetDeletedWorkItemShallowReferencesAsync(System.String,System.Object,System.Threading.CancellationToken)"> <summary> Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin. </summary> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetDeletedWorkItemShallowReferencesAsync(System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin. </summary> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.RestoreWorkItemAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteUpdate,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Restores the deleted work item from Recycle Bin. </summary> <param name="payload">Paylod with instructions to update the IsDeleted flag to false</param> <param name="id">ID of the work item to be restored</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.RestoreWorkItemAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteUpdate,System.String,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Restores the deleted work item from Recycle Bin. </summary> <param name="payload">Paylod with instructions to update the IsDeleted flag to false</param> <param name="project">Project ID or project name</param> <param name="id">ID of the work item to be restored</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.RestoreWorkItemAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteUpdate,System.Guid,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Restores the deleted work item from Recycle Bin. </summary> <param name="payload">Paylod with instructions to update the IsDeleted flag to false</param> <param name="project">Project ID</param> <param name="id">ID of the work item to be restored</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRevisionAsync(System.String,System.Int32,System.Int32,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns a fully hydrated work item for the requested revision </summary> <param name="project">Project ID or project name</param> <param name="id"></param> <param name="revisionNumber"></param> <param name="expand"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRevisionAsync(System.Guid,System.Int32,System.Int32,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns a fully hydrated work item for the requested revision </summary> <param name="project">Project ID</param> <param name="id"></param> <param name="revisionNumber"></param> <param name="expand"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRevisionAsync(System.Int32,System.Int32,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns a fully hydrated work item for the requested revision </summary> <param name="id"></param> <param name="revisionNumber"></param> <param name="expand"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRevisionsAsync(System.String,System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns the list of fully hydrated work item revisions, paged. </summary> <param name="project">Project ID or project name</param> <param name="id"></param> <param name="top"></param> <param name="skip"></param> <param name="expand"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRevisionsAsync(System.Guid,System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns the list of fully hydrated work item revisions, paged. </summary> <param name="project">Project ID</param> <param name="id"></param> <param name="top"></param> <param name="skip"></param> <param name="expand"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRevisionsAsync(System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns the list of fully hydrated work item revisions, paged. </summary> <param name="id"></param> <param name="top"></param> <param name="skip"></param> <param name="expand"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.EvaluateRulesOnFieldAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldsToEvaluate,System.Object,System.Threading.CancellationToken)"> <summary> Validates the fields values. </summary> <param name="ruleEngineInput"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateTemplateAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTemplate,Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Creates a template </summary> <param name="template">Template contents</param> <param name="teamContext">The team context for the operation</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetTemplatesAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets template </summary> <param name="teamContext">The team context for the operation</param> <param name="workitemtypename">Optional, When specified returns templates for given Work item type.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteTemplateAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Deletes the template with given id </summary> <param name="teamContext">The team context for the operation</param> <param name="templateId">Template id</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetTemplateAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the template with specified id </summary> <param name="teamContext">The team context for the operation</param> <param name="templateId">Template Id</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReplaceTemplateAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTemplate,Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Replace template contents </summary> <param name="templateContent">Template contents to replace with</param> <param name="teamContext">The team context for the operation</param> <param name="templateId">Template id</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetUpdateAsync(System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Returns a single update for a work item </summary> <param name="id"></param> <param name="updateNumber"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetUpdateAsync(System.String,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Returns a single update for a work item </summary> <param name="project">Project ID or project name</param> <param name="id"></param> <param name="updateNumber"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetUpdateAsync(System.Guid,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> Returns a single update for a work item </summary> <param name="project">Project ID</param> <param name="id"></param> <param name="updateNumber"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetUpdatesAsync(System.String,System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Returns a the deltas between work item revisions </summary> <param name="project">Project ID or project name</param> <param name="id"></param> <param name="top"></param> <param name="skip"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetUpdatesAsync(System.Guid,System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Returns a the deltas between work item revisions </summary> <param name="project">Project ID</param> <param name="id"></param> <param name="top"></param> <param name="skip"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetUpdatesAsync(System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Returns a the deltas between work item revisions </summary> <param name="id"></param> <param name="top"></param> <param name="skip"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryByWiqlAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Wiql,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given its WIQL. </summary> <param name="wiql">The query containing the WIQL.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryByWiqlAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Wiql,Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given its WIQL. </summary> <param name="wiql">The query containing the WIQL.</param> <param name="teamContext">The team context for the operation</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryByWiqlAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Wiql,System.String,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given its WIQL. </summary> <param name="wiql">The query containing the WIQL.</param> <param name="project">Project ID or project name</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryByWiqlAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Wiql,System.Guid,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given its WIQL. </summary> <param name="wiql">The query containing the WIQL.</param> <param name="project">Project ID</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueryResultCountAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.Guid,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given the query ID. </summary> <param name="teamContext">The team context for the operation</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueryResultCountAsync(System.String,System.Guid,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given the query ID. </summary> <param name="project">Project ID or project name</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueryResultCountAsync(System.Guid,System.Guid,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given the query ID. </summary> <param name="project">Project ID</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetQueryResultCountAsync(System.Guid,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given the query ID. </summary> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryByIdAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.Guid,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given the query ID. </summary> <param name="teamContext">The team context for the operation</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryByIdAsync(System.String,System.Guid,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given the query ID. </summary> <param name="project">Project ID or project name</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryByIdAsync(System.Guid,System.Guid,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given the query ID. </summary> <param name="project">Project ID</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.QueryByIdAsync(System.Guid,System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Gets the results of the query given the query ID. </summary> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="top">The max number of results to return.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemIconJsonAsync(System.String,System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Get a work item icon given the friendly name and icon color. </summary> <param name="icon">The name of the icon</param> <param name="color">The 6-digit hex color for the icon</param> <param name="v">The version of the icon (used only for cache invalidation)</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemIconsAsync(System.Object,System.Threading.CancellationToken)"> <summary> Get a list of all work item icons. </summary> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemIconSvgAsync(System.String,System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Get a work item icon given the friendly name and icon color. </summary> <param name="icon">The name of the icon</param> <param name="color">The 6-digit hex color for the icon</param> <param name="v">The version of the icon (used only for cache invalidation)</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemIconXamlAsync(System.String,System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Get a work item icon given the friendly name and icon color. </summary> <param name="icon">The name of the icon</param> <param name="color">The 6-digit hex color for the icon</param> <param name="v">The version of the icon (used only for cache invalidation)</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetReportingLinksByLinkTypeAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Object,System.Threading.CancellationToken)"> <summary> Get a batch of work item links </summary> <param name="project">Project ID or project name</param> <param name="linkTypes">A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.</param> <param name="continuationToken">Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.</param> <param name="startDateTime">Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetReportingLinksByLinkTypeAsync(System.Guid,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Object,System.Threading.CancellationToken)"> <summary> Get a batch of work item links </summary> <param name="project">Project ID</param> <param name="linkTypes">A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.</param> <param name="continuationToken">Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.</param> <param name="startDateTime">Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetReportingLinksByLinkTypeAsync(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Object,System.Threading.CancellationToken)"> <summary> Get a batch of work item links </summary> <param name="linkTypes">A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.</param> <param name="continuationToken">Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.</param> <param name="startDateTime">Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRelationTypeAsync(System.String,System.Object,System.Threading.CancellationToken)"> <summary> Gets the work item relation type definition. </summary> <param name="relation">The relation name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetRelationTypesAsync(System.Object,System.Threading.CancellationToken)"> <summary> Gets the work item relation types. </summary> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReadReportingRevisionsGetAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Get a batch of work item revisions with the option of including deleted items </summary> <param name="project">Project ID or project name</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="includeTagRef">Specify if the tag objects should be returned for System.Tags field.</param> <param name="includeLatestOnly">Return only the latest revisions of work items, skipping all historical revisions</param> <param name="expand">Return all the fields in work item revisions, including long text fields which are not returned by default</param> <param name="includeDiscussionChangesOnly">Return only the those revisions of work items, where only history field was changed</param> <param name="maxPageSize">The maximum number of results to return in this batch</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReadReportingRevisionsGetAsync(System.Guid,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Get a batch of work item revisions with the option of including deleted items </summary> <param name="project">Project ID</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="includeTagRef">Specify if the tag objects should be returned for System.Tags field.</param> <param name="includeLatestOnly">Return only the latest revisions of work items, skipping all historical revisions</param> <param name="expand">Return all the fields in work item revisions, including long text fields which are not returned by default</param> <param name="includeDiscussionChangesOnly">Return only the those revisions of work items, where only history field was changed</param> <param name="maxPageSize">The maximum number of results to return in this batch</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReadReportingRevisionsGetAsync(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> Get a batch of work item revisions with the option of including deleted items </summary> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="includeTagRef">Specify if the tag objects should be returned for System.Tags field.</param> <param name="includeLatestOnly">Return only the latest revisions of work items, skipping all historical revisions</param> <param name="expand">Return all the fields in work item revisions, including long text fields which are not returned by default</param> <param name="includeDiscussionChangesOnly">Return only the those revisions of work items, where only history field was changed</param> <param name="maxPageSize">The maximum number of results to return in this batch</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReadReportingRevisionsPostAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter,System.String,System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Object,System.Threading.CancellationToken)"> <summary> Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit. </summary> <param name="filter">An object that contains request settings: field filter, type filter, identity format</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="expand"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReadReportingRevisionsPostAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter,System.String,System.String,System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Object,System.Threading.CancellationToken)"> <summary> Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit. </summary> <param name="filter">An object that contains request settings: field filter, type filter, identity format</param> <param name="project">Project ID or project name</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="expand"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReadReportingRevisionsPostAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter,System.Guid,System.String,System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Object,System.Threading.CancellationToken)"> <summary> Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit. </summary> <param name="filter">An object that contains request settings: field filter, type filter, identity format</param> <param name="project">Project ID</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="expand"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReadReportingDiscussionsAsync(System.String,System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="project">Project ID or project name</param> <param name="continuationToken"></param> <param name="maxPageSize"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReadReportingDiscussionsAsync(System.Guid,System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="project">Project ID</param> <param name="continuationToken"></param> <param name="maxPageSize"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ReadReportingDiscussionsAsync(System.String,System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="continuationToken"></param> <param name="maxPageSize"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Creates a single work item. </summary> <param name="document">The JSON Patch document representing the work item</param> <param name="project">Project ID or project name</param> <param name="type">The work item type of the work item to create</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.CreateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Guid,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Creates a single work item. </summary> <param name="document">The JSON Patch document representing the work item</param> <param name="project">Project ID</param> <param name="type">The work item type of the work item to create</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTemplateAsync(System.String,System.String,System.String,System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns a single work item from a template. </summary> <param name="project">Project ID or project name</param> <param name="type">The work item type name</param> <param name="fields">Comma-separated list of requested fields</param> <param name="asOf">AsOf UTC date time string</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTemplateAsync(System.Guid,System.String,System.String,System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns a single work item from a template. </summary> <param name="project">Project ID</param> <param name="type">The work item type name</param> <param name="fields">Comma-separated list of requested fields</param> <param name="asOf">AsOf UTC date time string</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteWorkItemAsync(System.String,System.Int32,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution. </summary> <param name="project">Project ID or project name</param> <param name="id">ID of the work item to be deleted</param> <param name="destroy">Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteWorkItemAsync(System.Guid,System.Int32,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution. </summary> <param name="project">Project ID</param> <param name="id">ID of the work item to be deleted</param> <param name="destroy">Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.DeleteWorkItemAsync(System.Int32,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution. </summary> <param name="id">ID of the work item to be deleted</param> <param name="destroy">Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemAsync(System.String,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns a single work item. </summary> <param name="project">Project ID or project name</param> <param name="id">The work item id</param> <param name="fields">Comma-separated list of requested fields</param> <param name="asOf">AsOf UTC date time string</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemAsync(System.Guid,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns a single work item. </summary> <param name="project">Project ID</param> <param name="id">The work item id</param> <param name="fields">Comma-separated list of requested fields</param> <param name="asOf">AsOf UTC date time string</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemAsync(System.Int32,System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Returns a single work item. </summary> <param name="id">The work item id</param> <param name="fields">Comma-separated list of requested fields</param> <param name="asOf">AsOf UTC date time string</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemsAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemErrorPolicy},System.Object,System.Threading.CancellationToken)"> <summary> Returns a list of work items (Maximum 200) </summary> <param name="project">Project ID or project name</param> <param name="ids">The comma-separated list of requested work item ids. (Maximum 200 ids allowed).</param> <param name="fields">Comma-separated list of requested fields</param> <param name="asOf">AsOf UTC date time string</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="errorPolicy">The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemsAsync(System.Guid,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemErrorPolicy},System.Object,System.Threading.CancellationToken)"> <summary> Returns a list of work items (Maximum 200) </summary> <param name="project">Project ID</param> <param name="ids">The comma-separated list of requested work item ids. (Maximum 200 ids allowed).</param> <param name="fields">Comma-separated list of requested fields</param> <param name="asOf">AsOf UTC date time string</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="errorPolicy">The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemsAsync(System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTime},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemErrorPolicy},System.Object,System.Threading.CancellationToken)"> <summary> Returns a list of work items (Maximum 200) </summary> <param name="ids">The comma-separated list of requested work item ids. (Maximum 200 ids allowed).</param> <param name="fields">Comma-separated list of requested fields</param> <param name="asOf">AsOf UTC date time string</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="errorPolicy">The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Int32,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Updates a single work item. </summary> <param name="document">The JSON Patch document representing the update</param> <param name="id">The id of the work item to update</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.String,System.Int32,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Updates a single work item. </summary> <param name="document">The JSON Patch document representing the update</param> <param name="project">Project ID or project name</param> <param name="id">The id of the work item to update</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Guid,System.Int32,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand},System.Object,System.Threading.CancellationToken)"> <summary> Updates a single work item. </summary> <param name="document">The JSON Patch document representing the update</param> <param name="project">Project ID</param> <param name="id">The id of the work item to update</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="expand">The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemsBatchAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemBatchGetRequest,System.Object,System.Threading.CancellationToken)"> <summary> Gets work items for a list of work item ids (Maximum 200) </summary> <param name="workItemGetRequest"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemsBatchAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemBatchGetRequest,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Gets work items for a list of work item ids (Maximum 200) </summary> <param name="workItemGetRequest"></param> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemsBatchAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemBatchGetRequest,System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> Gets work items for a list of work item ids (Maximum 200) </summary> <param name="workItemGetRequest"></param> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemStateColorsAsync(System.String[],System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] INTERNAL ONLY: It will be used for My account work experience. Get the work item type state color for multiple projects </summary> <param name="projectNames"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemNextStatesOnCheckinActionAsync(System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns the next state on the given work item IDs. </summary> <param name="ids">list of work item ids</param> <param name="action">possible actions. Currently only supports checkin</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeCategoriesAsync(System.String,System.Object,System.Threading.CancellationToken)"> <summary> Get all work item type categories. </summary> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeCategoriesAsync(System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> Get all work item type categories. </summary> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeCategoryAsync(System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Get specific work item type category by name. </summary> <param name="project">Project ID or project name</param> <param name="category">The category name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeCategoryAsync(System.Guid,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Get specific work item type category by name. </summary> <param name="project">Project ID</param> <param name="category">The category name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeColorsAsync(System.String[],System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] INTERNAL ONLY: It will be used for My account work experience. Get the wit type color for multiple projects </summary> <param name="projectNames"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeColorAndIconsAsync(System.String[],System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] INTERNAL ONLY: It is used for color and icon providers. Get the wit type color for multiple projects </summary> <param name="projectNames"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeAsync(System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Returns a work item type definition. </summary> <param name="project">Project ID or project name</param> <param name="type">Work item type name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeAsync(System.Guid,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Returns a work item type definition. </summary> <param name="project">Project ID</param> <param name="type">Work item type name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypesAsync(System.String,System.Object,System.Threading.CancellationToken)"> <summary> Returns the list of work item types </summary> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypesAsync(System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> Returns the list of work item types </summary> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeFieldsWithReferencesAsync(System.String,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel},System.Object,System.Threading.CancellationToken)"> <summary> Get a list of fields for a work item type with detailed references. </summary> <param name="project">Project ID or project name</param> <param name="type">Work item type.</param> <param name="expand">Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeFieldsWithReferencesAsync(System.Guid,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel},System.Object,System.Threading.CancellationToken)"> <summary> Get a list of fields for a work item type with detailed references. </summary> <param name="project">Project ID</param> <param name="type">Work item type.</param> <param name="expand">Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeFieldWithReferencesAsync(System.String,System.String,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel},System.Object,System.Threading.CancellationToken)"> <summary> Get a field for a work item type with detailed references. </summary> <param name="project">Project ID or project name</param> <param name="type">Work item type.</param> <param name="field"></param> <param name="expand">Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeFieldWithReferencesAsync(System.Guid,System.String,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel},System.Object,System.Threading.CancellationToken)"> <summary> Get a field for a work item type with detailed references. </summary> <param name="project">Project ID</param> <param name="type">Work item type.</param> <param name="field"></param> <param name="expand">Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeStatesAsync(System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns the state names and colors for a work item type. </summary> <param name="project">Project ID or project name</param> <param name="type">The state name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.GetWorkItemTypeStatesAsync(System.Guid,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns the state names and colors for a work item type. </summary> <param name="project">Project ID</param> <param name="type">The state name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ExportWorkItemTypeDefinitionAsync(System.String,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Export work item type </summary> <param name="project">Project ID or project name</param> <param name="type"></param> <param name="exportGlobalLists"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ExportWorkItemTypeDefinitionAsync(System.Guid,System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Export work item type </summary> <param name="project">Project ID</param> <param name="type"></param> <param name="exportGlobalLists"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.ExportWorkItemTypeDefinitionAsync(System.String,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> Export work item type </summary> <param name="type"></param> <param name="exportGlobalLists"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateWorkItemTypeDefinitionAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplateUpdateModel,System.Object,System.Threading.CancellationToken)"> <summary> Add/updates a work item type </summary> <param name="updateModel"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateWorkItemTypeDefinitionAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplateUpdateModel,System.String,System.Object,System.Threading.CancellationToken)"> <summary> Add/updates a work item type </summary> <param name="updateModel"></param> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientBase.UpdateWorkItemTypeDefinitionAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplateUpdateModel,System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> Add/updates a work item type </summary> <param name="updateModel"></param> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountMyWorkResult.WorkItemDetails"> <summary> WorkItem Details </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountMyWorkResult.QuerySizeLimitExceeded"> <summary> True, when length of WorkItemDetails is same as the limit </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase"> <summary> Represents Work Item Recent Activity </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase.Id"> <summary> Work Item Id </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase.WorkItemType"> <summary> Type of Work Item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase.Title"> <summary> Title of the work item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase.State"> <summary> State of the work item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase.ChangedDate"> <summary> Last changed date of the work item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase.TeamProject"> <summary> Team project the work item belongs to </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase.ActivityDate"> <summary> Date of the last Activity by the user </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase.ActivityType"> <summary> Type of the activity </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModelBase.IdentityId"> <summary> TeamFoundationId of the user this activity belongs to </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModel"> <summary> Represents Work Item Recent Activity </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModel.AssignedTo"> <summary> Assigned To </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModel2"> <summary> Represents Work Item Recent Activity </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentActivityWorkItemModel2.AssignedTo"> <summary> Assigned To </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemRecentActivityType"> <summary> Type of the activity </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentMentionWorkItemModel"> <summary> Represents Recent Mention Work Item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentMentionWorkItemModel.Id"> <summary> Work Item Id </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentMentionWorkItemModel.AssignedTo"> <summary> Assigned To </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentMentionWorkItemModel.WorkItemType"> <summary> Type of Work Item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentMentionWorkItemModel.Title"> <summary> Title of the work item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentMentionWorkItemModel.State"> <summary> State of the work item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentMentionWorkItemModel.TeamProject"> <summary> Team project the work item belongs to </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.AccountRecentMentionWorkItemModel.MentionedDateField"> <summary> Latest date that the user were mentioned </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder.Asc"> <summary> The results will be sorted in Ascending order. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder.Desc"> <summary> The results will be sorted in Descending order. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComment"> <summary> Comment on Work Item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComment.Revision"> <summary> The work item revision number. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComment.Text"> <summary> The text of the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComment.RevisedBy"> <summary> Identity of user who added the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComment.RevisedDate"> <summary> The date of comment. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments"> <summary> Collection of comments. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments.TotalCount"> <summary> Total count of comments. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments.FromRevisionCount"> <summary> Count of comments from the revision. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments.Count"> <summary> The count of comments. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments.Comments"> <summary> Comments collection. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment"> <summary> Comment on a Work Item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.WorkItemId"> <summary> The id of the work item this comment belongs to. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.Id"> <summary> The id assigned to the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.Version"> <summary> The current version of the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.Text"> <summary> The text of the comment. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.Reactions"> <summary> The reactions of the comment. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.Mentions"> <summary> The mentions of the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.CreatedBy"> <summary> <see cref="T:Microsoft.VisualStudio.Services.WebApi.IdentityRef"/> of the creator of the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.CreatedDate"> <summary> The creation date of the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.CreatedOnBehalfOf"> <summary> Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.CreatedOnBehalfDate"> <summary> Effective Date/time value for adding the comment. Can be optionally different from CreatedDate. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.ModifiedBy"> <summary> <see cref="T:Microsoft.VisualStudio.Services.WebApi.IdentityRef"/> of the user who last modified the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.ModifiedDate"> <summary> The last modification date of the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Comment.IsDeleted"> <summary> Indicates if the comment has been deleted. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentList"> <summary> Represents a list of work item comments. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentList.TotalCount"> <summary> Total count of comments on a work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentList.Count"> <summary> The count of comments in the current batch. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentList.Comments"> <summary> List of comments in the current batch. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentList.NextPage"> <summary> Uri to the next page of comments if it is available. Otherwise null. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentList.ContinuationToken"> <summary> A string token that can be used to retrieving next page of comments if available. Otherwise null. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentCreate"> <summary> Represents a request to create a work item comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentCreate.Text"> <summary> The text of the comment. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions"> <summary> Specifies the additional data retrieval options for work item comments. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions.Reactions"> <summary> Include comment reactions. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions.Mentions"> <summary> Include comment mentions. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions.RenderedText"> <summary> Include the rendered text (html) in addition to MD text. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentExpandOptions.RenderedTextOnly"> <summary> If specified, then ONLY rendered text (html) will be returned, w/o markdown. Supposed to be used internally from data provides for optimization purposes. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentFormat"> <summary> Represents the possible types for the comment format. Should be in sync with WorkItemCommentFormat.cs </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentMention.ArtifactId"> <summary> The artifact portion of the parsed text. (i.e. the work item's id) </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentMention.ArtifactType"> <summary> The type the parser assigned to the mention. (i.e. person, work item, etc) </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentMention.CommentId"> <summary> The comment id of the mention. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentMention.TargetId"> <summary> The resolved target of the mention. An example of this could be a user's tfid </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReaction"> <summary> Contains information about work item comment reaction for a particular reaction type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReaction.Type"> <summary> Type of the reaction. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReaction.Count"> <summary> Total number of reactions for the <see cref="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReactionType"/>. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReaction.IsCurrentUserEngaged"> <summary> Flag to indicate if the current user has engaged on this particular EngagementType (e.g. if they liked the associated comment). </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReaction.CommentId"> <summary> The id of the comment this reaction belongs to. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentReactionType"> <summary> Represents different reaction types for a work item comment. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentUpdate"> <summary> Represents a request to update a work item comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentUpdate.Text"> <summary> The updated text of the comment. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion"> <summary> Represents a specific version of a comment on a work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.Id"> <summary> The id assigned to the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.Version"> <summary> The version number. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.Text"> <summary> The text of the comment at this version. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.RenderedText"> <summary> The rendered content of the comment at this version. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.CreatedBy"> <summary> <see cref="T:Microsoft.VisualStudio.Services.WebApi.IdentityRef"/> of the creator of the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.CreatedDate"> <summary> The creation date of the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.CreatedOnBehalfOf"> <summary> Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.CreatedOnBehalfDate"> <summary> Effective Date/time value for adding the comment. Can be optionally different from CreatedDate. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.ModifiedBy"> <summary> <see cref="T:Microsoft.VisualStudio.Services.WebApi.IdentityRef"/> of the user who modified the comment at this version. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.ModifiedDate"> <summary> The modification date of the comment for this version. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentVersion.IsDeleted"> <summary> Indicates if the comment has been deleted at this version. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemCommentVersionRef"> <summary> Represents the reference to a specific version of a comment on a Work Item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemCommentVersionRef.CommentId"> <summary> The id assigned to the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemCommentVersionRef.Version"> <summary> The version number. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemCommentVersionRef.Text"> <summary> [Internal] The text of the comment. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemCommentVersionRef.CreatedInRevision"> <summary> [Internal] The work item revision where this comment was originally added. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemCommentVersionRef.IsDeleted"> <summary> [Internal] Specifies whether comment was deleted. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.IdentityReference"> <summary> Describes a reference to an identity. </summary> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.IdentityReference.#ctor"> <summary> For back-compat purpose only, do not use for public project </summary> </member> <!-- Badly formed XML comment ignored for member "P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.IdentityReference.Id" --> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.IdentityReference.Name"> <summary> Legacy back-compat property. This has been the WIT specific value from Constants. Will be hidden (but exists) on the client unless they are targeting the newest version </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ArtifactUriQuery"> <summary> Contains criteria for querying work items based on artifact URI. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ArtifactUriQuery.ArtifactUris"> <summary> List of artifact URIs to use for querying work items. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ArtifactUriQueryResult"> <summary> Defines result of artifact URI query on work items. Contains mapping of work item IDs to artifact URI. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ArtifactUriQueryResult.ArtifactUrisQueryResult"> <summary> A Dictionary that maps a list of work item references to the given list of artifact URI. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Link"> <summary> Link description. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Link.Rel"> <summary> Relation type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Link.Url"> <summary> Link url. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Link.Title"> <summary> Link title. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Link.Attributes"> <summary> Collection of link attributes. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkArtifactLink"> <summary> A work artifact link describes an outbound artifact link type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkArtifactLink.LinkType"> <summary> Outbound link type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkArtifactLink.ArtifactType"> <summary> Target artifact type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkArtifactLink.ToolType"> <summary> Target tool type. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemRelationType"> <summary> Represents the work item type relation type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemRelationType.Attributes"> <summary> The collection of relation type attributes. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemRelationUpdates"> <summary> Describes updates to a work item's relations. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemRelationUpdates.Added"> <summary> List of newly added relations. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemRelationUpdates.Removed"> <summary> List of removed relations. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemRelationUpdates.Updated"> <summary> List of updated relations. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTrackingReference.ReferenceName"> <summary> The reference name. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTrackingReference.Name"> <summary> The name. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.RemoteWorkItemLinkUpdate.LocalWorkItemTitle"> <summary> For notification purpose </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.RemoteWorkItemLinkUpdate.LocalWorkItemType"> <summary> For notification purpose </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Metadata.ClassificationNodesErrorPolicy"> <summary> Flag to control error policy in a batch classification nodes get request. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldDependentRule"> <summary> Describes a list of dependent fields for a rule. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldDependentRule.DependentFields"> <summary> The dependent fields. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldStatusFlags"> <summary> Enumerates various rule validation error reasons for a field. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType"> <summary> Enum for field types. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.String"> <summary> String field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.Integer"> <summary> Integer field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.DateTime"> <summary> Datetime field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.PlainText"> <summary> Plain text field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.Html"> <summary> HTML (Multiline) field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.TreePath"> <summary> Treepath field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.History"> <summary> History field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.Double"> <summary> Double field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.Guid"> <summary> Guid field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.Boolean"> <summary> Boolean field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.Identity"> <summary> Identity field type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.PicklistString"> <summary> String picklist field type. When creating a string picklist field from REST API, use "String" FieldType. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.PicklistInteger"> <summary> Integer picklist field type. When creating a integer picklist field from REST API, use "Integer" FieldType. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldType.PicklistDouble"> <summary> Double picklist field type. When creating a double picklist field from REST API, use "Double" FieldType. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldUsage"> <summary> Enum for field usages. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldUsage.None"> <summary> Empty usage. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldUsage.WorkItem"> <summary> Work item field usage. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldUsage.WorkItemLink"> <summary> Work item link field usage. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldUsage.Tree"> <summary> Treenode field usage. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldUsage.WorkItemTypeExtension"> <summary> Work Item Type Extension usage. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.GetFieldsExpand"> <summary> Flag to expand types of fields. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.GetFieldsExpand.None"> <summary> Default behavior. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.GetFieldsExpand.ExtensionFields"> <summary> Adds extension fields to the response. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProjectWorkItemStateColors"> <summary> Project work item type state colors </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProjectWorkItemStateColors.ProjectName"> <summary> Project name </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProjectWorkItemStateColors.workItemTypeStateColors"> <summary> State colors for all work item type in a project </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProvisioningActionType"> <summary> Enumerates the possible provisioning actions that can be triggered on process template update. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProvisioningResult"> <summary> Result of an update work item type XML update operation. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProvisioningResult.ProvisioningImportEvents"> <summary> Details about of the provisioning import events. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TemplateType"> <summary> Enumerates types of supported xml templates used for customization. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeNodeStructureType"> <summary> Types of tree node structures. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeNodeStructureType.Area"> <summary> Area type. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeNodeStructureType.Iteration"> <summary> Iteration type. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.TreeStructureGroup"> <summary> Types of tree structures groups. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode"> <summary> Defines a classification node for work item tracking. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode.Id"> <summary> Integer ID of the classification node. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode.Identifier"> <summary> GUID ID of the classification node. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode.Name"> <summary> Name of the classification node. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode.StructureType"> <summary> Node structure type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode.HasChildren"> <summary> Flag that indicates if the classification node has any child nodes. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode.Children"> <summary> List of child nodes fetched. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode.Attributes"> <summary> Dictionary that has node attributes like start/finish date for iteration nodes. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode.Path"> <summary> Path of the classification node. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField"> <summary> Describes a field on a work item and it's properties specific to that work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.Name"> <summary> The name of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.ReferenceName"> <summary> The reference name of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.Description"> <summary> The description of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.Type"> <summary> The type of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.Usage"> <summary> The usage of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.ReadOnly"> <summary> Indicates whether the field is [read only]. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.CanSortBy"> <summary> Indicates whether the field is sortable in server queries. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.IsQueryable"> <summary> Indicates whether the field can be queried in the server. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.SupportedOperations"> <summary> The supported operations on this field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.IsIdentity"> <summary> Indicates whether this field is an identity field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.IsPicklist"> <summary> Indicates whether this instance is picklist. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.IsPicklistSuggested"> <summary> Indicates whether this instance is a suggested picklist . </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemField.PicklistId"> <summary> If this field is picklist, the identifier of the picklist associated, otherwise null </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldOperation"> <summary> Describes a work item field operation. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldOperation.ReferenceName"> <summary> Reference name of the operation. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldOperation.Name"> <summary> Friendly name of the operation. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldReference"> <summary> Reference to a field in a work item </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldReference.ReferenceName"> <summary> The reference name of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldReference.Name"> <summary> The friendly name of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldReference.Url"> <summary> The REST URL of the resource. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemIcon"> <summary> Reference to a work item icon. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemIcon.Id"> <summary> The identifier of the icon. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemIcon.Url"> <summary> The REST URL of the resource. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemStateColor"> <summary> Work item type state name, color and state category </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemStateColor.Name"> <summary> Work item type state name </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemStateColor.Color"> <summary> Color value </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemStateColor.Category"> <summary> Category of state </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemStateTransition"> <summary> Describes a state transition in a work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemStateTransition.To"> <summary> Name of the next state. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemStateTransition.Actions"> <summary> Gets a list of actions needed to transition to that state. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType"> <summary> Describes a work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.Name"> <summary> Gets the name of the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.ReferenceName"> <summary> The reference name of the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.Description"> <summary> The description of the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.Color"> <summary> The color. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.Icon"> <summary> The icon of the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.IsDisabled"> <summary> True if work item type is disabled </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.XmlForm"> <summary> The XML form. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.Fields"> <summary> The fields that exist on the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.FieldInstances"> <summary> The fields that exist on the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.Transitions"> <summary> Gets the various state transition mappings in the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType.States"> <summary> Gets state information for the work item type. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeCategory"> <summary> Describes a work item type category. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeCategory.Name"> <summary> The name of the category. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeCategory.ReferenceName"> <summary> The reference name of the category. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeCategory.DefaultWorkItemType"> <summary> Gets or sets the default type of the work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeCategory.WorkItemTypes"> <summary> The work item types that belong to the category. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeColor"> <summary> Describes a work item type's colors. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeColor.WorkItemTypeName"> <summary> The name of the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeColor.PrimaryColor"> <summary> Gets or sets the color of the primary. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeColor.SecondaryColor"> <summary> Gets or sets the color of the secondary. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeColorAndIcon"> <summary> Describes work item type nam, its icon and color. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeColorAndIcon.WorkItemTypeName"> <summary> The name of the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeColorAndIcon.Color"> <summary> The color of the work item type in hex format. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeColorAndIcon.Icon"> <summary> The work item type icon. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstance"> <summary> Field instance of a work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstance.DefaultValue"> <summary> Represents the default value of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstance.AllowedValues"> <summary> The list of field allowed values. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstanceBase"> <summary> Base field instance for workItemType fields. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstanceBase.Field"> <summary> The field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstanceBase.HelpText"> <summary> Gets the help text for the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstanceBase.AlwaysRequired"> <summary> Indicates whether field value is always required. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstanceBase.DependentFields"> <summary> The list of dependent fields. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstanceBase.IsIdentity"> <summary> flag which tells if current field is identity. </summary> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldInstanceBase.Equals(System.Object)"> <summary> This function is called when JSON serializer tries to check circular reference for an object of this class. JSON serializer checks every member and their members if any of them is equal to this object and throws error. Without this function we were getting self loop error as serializer was using base class equal method and some member of this class were getting matched with base class object. </summary> <param name="obj"></param> <returns></returns> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel"> <summary> Expand options for the work item field(s) request. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel.None"> <summary> Includes only basic properties of the field. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel.AllowedValues"> <summary> Includes allowed values for the field. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel.DependentFields"> <summary> Includes dependent fields of the field. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel.All"> <summary> Includes allowed values and dependent fields of the field. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldWithReferences"> <summary> Field Instance of a workItemype with detailed references. </summary> We need to revise the model because allowed values has type string[] in old model and there can be Identities in allowed values and in future there may be some other datatype. For identities it is public projects guideline to return IdentityRef so to do that we are converting AllowedValues datatype to Object[] in this revised model. </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldWithReferences.DefaultValue"> <summary> Represents the default value of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldWithReferences.AllowedValues"> <summary> The list of field allowed values. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeReference"> <summary> Reference to a work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeReference.Name"> <summary> Name of the work item type. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeStateColors"> <summary> State colors for a work item type </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeStateColors.WorkItemTypeName"> <summary> Work item type name </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeStateColors.StateColors"> <summary> Work item type state colors </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplate"> <summary> Describes a work item type template. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplate.Template"> <summary> XML template in string format. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplateUpdateModel"> <summary> Describes a update work item type template request body. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplateUpdateModel.Template"> <summary> String representation of the work item type template. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplateUpdateModel.Methodology"> <summary> Methodology to which the template belongs, eg. Agile, Scrum, CMMI. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplateUpdateModel.ActionType"> <summary> Describes the type of the action for the update request. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeTemplateUpdateModel.TemplateType"> <summary> The type of the template described in the request body. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProjectReference"> <summary> Describes a reference to a project. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProjectReference.Id"> <summary> The project identifier. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProjectReference.Name"> <summary> The name of the project. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ProjectReference.Url"> <summary> The REST URL of the project. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryType"> <summary> The type of query. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryType.Flat"> <summary> Gets a flat list of work items. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryType.Tree"> <summary> Gets a tree of work items showing their link hierarchy. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryType.OneHop"> <summary> Gets a list of work items and their direct links. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryResultType"> <summary> The query result type </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryResultType.WorkItem"> <summary> A list of work items (for flat queries). </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryResultType.WorkItemLink"> <summary> A list of work item links (for OneHop and Tree queries). </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.LinkQueryMode"> <summary> The link query mode which determines the behavior of the query. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.LinkQueryMode.WorkItems"> <summary> Returns flat list of work items. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.LinkQueryMode.LinksOneHopMustContain"> <summary> Returns work items where the source, target, and link criteria are all satisfied. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.LinkQueryMode.LinksOneHopMayContain"> <summary> Returns work items that satisfy the source and link criteria, even if no linked work item satisfies the target criteria. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.LinkQueryMode.LinksOneHopDoesNotContain"> <summary> Returns work items that satisfy the source, only if no linked work item satisfies the link and target criteria. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.LinkQueryMode.LinksRecursiveMayContain"> <summary> Returns work items a hierarchy of work items that by default satisfy the source </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryRecursionOption"> <summary> Determines whether a tree query matches parents or children first. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryRecursionOption.ParentFirst"> <summary> Returns work items that satisfy the source, even if no linked work item satisfies the target and link criteria. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryRecursionOption.ChildFirst"> <summary> Returns work items that satisfy the target criteria, even if no work item satisfies the source and link criteria. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItemsResult.Count"> <summary> The count of items. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItemsResult.Value"> <summary> The list of items </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItemsResult.HasMore"> <summary> Indicates if the max return limit was hit but there are still more items </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem"> <summary> Represents an item in the work item query hierarchy. This can be either a query or a folder. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.Id"> <summary> The id of the query item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.Name"> <summary> The name of the query item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.Path"> <summary> The path of the query item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.CreatedBy"> <summary> The identity who created the query item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.CreatedDate"> <summary> When the query item was created. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.LastModifiedBy"> <summary> The identity who last modified the query item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.LastModifiedDate"> <summary> When the query item was last modified. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.IsFolder"> <summary> Indicates if this is a query folder or a query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.HasChildren"> <summary> If this is a query folder, indicates if it contains any children. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.Children"> <summary> The child query items inside a query folder. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.QueryType"> <summary> The type of query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.Columns"> <summary> The columns of the query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.SortColumns"> <summary> The sort columns of the query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.Wiql"> <summary> The WIQL text of the query </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.IsDeleted"> <summary> Indicates if this query item is deleted. Setting this to false on a deleted query item will undelete it. Undeleting a query or folder will not bring back the permission changes that were previously applied to it. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.IsPublic"> <summary> Indicates if this query item is public or private. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.IsInvalidSyntax"> <summary> Indicates if the WIQL of this query is invalid. This could be due to invalid syntax or a no longer valid area/iteration path. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.LinkClauses"> <summary> The link query clause. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.FilterOptions"> <summary> The link query mode. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.QueryRecursionOption"> <summary> The recursion option for use in a tree query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.Clauses"> <summary> The clauses for a flat query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.SourceClauses"> <summary> The source clauses in a tree or one-hop link query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.TargetClauses"> <summary> The target clauses in a tree or one-hop link query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.LastExecutedBy"> <summary> The identity who last ran the query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem.LastExecutedDate"> <summary> When the query was last run. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryResult"> <summary> The result of a work item query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryResult.QueryType"> <summary> The type of the query </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryResult.QueryResultType"> <summary> The result type </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryResult.AsOf"> <summary> The date the query was run in the context of. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryResult.Columns"> <summary> The columns of the query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryResult.SortColumns"> <summary> The sort columns of the query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryResult.WorkItems"> <summary> The work items returned by the query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryResult.WorkItemRelations"> <summary> The work item links returned by the query. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemLink"> <summary> A link between two work items. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemLink.Rel"> <summary> The type of link. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemLink.Source"> <summary> The source work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemLink.Target"> <summary> The target work item. </summary> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemLink.#ctor(System.String)"> <summary> internal use only - for ISecuredObject information </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQuerySortColumn"> <summary> A sort column. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQuerySortColumn.Field"> <summary> A work item field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQuerySortColumn.Descending"> <summary> The direction to sort by. </summary> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQuerySortColumn.#ctor(Microsoft.VisualStudio.Services.WebApi.ISecuredObject)"> <summary> internal use only - for ISecuredObject information </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryBatchGetRequest"> <summary> Describes a request to get a list of queries </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryBatchGetRequest.Ids"> <summary> The requested query ids </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryBatchGetRequest.Expand"> <summary> The expand parameters for queries. Possible options are { None, Wiql, Clauses, All, Minimal } </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryBatchGetRequest.ErrorPolicy"> <summary> The flag to control error policy in a query batch request. Possible options are { Fail, Omit }. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryErrorPolicy"> <summary> Enum to control error policy in a query batch request. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand"> <summary> Determines which set of additional query properties to display </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand.None"> <summary> Expands Columns, Links and ChangeInfo </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand.Wiql"> <summary> Expands Columns, Links, ChangeInfo and WIQL text </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand.Clauses"> <summary> Expands Columns, Links, ChangeInfo, WIQL text and clauses </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand.All"> <summary> Expands all properties </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand.Minimal"> <summary> Displays minimal properties and the WIQL text </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Wiql"> <summary> A WIQL query </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.Wiql.Query"> <summary> The text of the WIQL query </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryClause"> <summary> Represents a clause in a work item query. This shows the structure of a work item query. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryClause.LogicalOperator"> <summary> Logical operator separating the condition clause </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryClause.Clauses"> <summary> Child clauses if the current clause is a logical operator </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryClause.Field"> <summary> Field associated with condition </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryClause.Operator"> <summary> The field operator </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryClause.Value"> <summary> Right side of the condition when a field to value comparison </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryClause.IsFieldValue"> <summary> Determines if this is a field to field comparison </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryClause.FieldValue"> <summary> Right side of the condition when a field to field comparison </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemQueryClause.LogicalOperation"> <summary> The logical operation </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDelete"> <summary> Full deleted work item object. Includes the work item itself. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDelete.Resource"> <summary> The work item object that was deleted. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference"> <summary> Reference to a deleted work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference.Id"> <summary> Work item ID. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference.Type"> <summary> Type of work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference.Name"> <summary> Name or title of the work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference.Project"> <summary> Parent project of the deleted work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference.DeletedDate"> <summary> The work item deletion date. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference.DeletedBy"> <summary> The user who deleted the work item type. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference.Code"> <summary> The HTTP status code for work item operation in a batch request. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference.Message"> <summary> The exception message for work item operation in a batch request. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteReference.Url"> <summary> REST API URL of the resource </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteShallowReference"> <summary> Shallow Reference to a deleted work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteShallowReference.Id"> <summary> Work item ID. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteShallowReference.Url"> <summary> REST API URL of the resource </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteUpdate"> <summary> Describes an update request for a deleted work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemDeleteUpdate.IsDeleted"> <summary> Sets a value indicating whether this work item is deleted. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand"> <summary> The reporting revision expand level. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand.None"> <summary> Default behavior. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand.Fields"> <summary> Add fields to the response. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter"> <summary> The class represents the reporting work item revision filer. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter.Fields"> <summary> A list of fields to return in work item revisions. Omit this parameter to get all reportable fields. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter.Types"> <summary> A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter.IncludeIdentityRef"> <summary> Return an identity reference instead of a string value for identity fields. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter.IncludeDeleted"> <summary> Include deleted work item in the result. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter.IncludeTagRef"> <summary> Include tag reference instead of string value for System.Tags field </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter.IncludeLatestOnly"> <summary> Include only the latest version of a work item, skipping over all previous revisions of the work item. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.StreamedBatch`1"> <summary> The class describes reporting work item revision batch. </summary> <typeparam name="T"></typeparam> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.StreamedBatch`1.Values"> <summary> Values such as rel, sourceId, TargetId, ChangedDate, isActive. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.StreamedBatch`1.NextLink"> <summary> The next link for the work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.StreamedBatch`1.ContinuationToken"> <summary> ContinuationToken acts as a waterMark. Used while querying large results. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.StreamedBatch`1.IsLastBatch"> <summary> Returns 'true' if it's last batch, 'false' otherwise. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldsToEvaluate"> <summary> Describes a set fields for rule evaluation. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldsToEvaluate.RulesFrom"> <summary> URL of the work item type for which the rules need to be executed. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldsToEvaluate.Fields"> <summary> List of fields to evaluate. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldsToEvaluate.FieldValues"> <summary> Initial field values. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.FieldsToEvaluate.FieldUpdates"> <summary> Updated field values to evaluate. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemBatchGetRequest"> <summary> Describes a request to get a set of work items </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemBatchGetRequest.Ids"> <summary> The requested work item ids </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemBatchGetRequest.Fields"> <summary> The requested fields </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemBatchGetRequest.AsOf"> <summary> AsOf UTC date time string </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemBatchGetRequest.Expand"> <summary> The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All } </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemBatchGetRequest.ErrorPolicy"> <summary> The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest"> <summary> Describes a batch work item request. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest.Method"> <summary> The REST method. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest.Uri"> <summary> The REST end points URI. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest.Headers"> <summary> Request headers. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest.Body"> <summary> The request body. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchResponse"> <summary> Describes response for batch request. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchResponse.Code"> <summary> The HTTP status code of the response . </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchResponse.Headers"> <summary> Response headers. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchResponse.Body"> <summary> The response body. </summary> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchResponse.ParseBody``1(System.Net.Http.Formatting.MediaTypeFormatter)"> <summary> Parses the body content of batch response with given data type. </summary> <typeparam name="T">Data type to parse response body</typeparam> <param name="formatter">Body content formatter. Default is <see cref="T:Microsoft.VisualStudio.Services.WebApi.VssJsonMediaTypeFormatter"/></param> <returns>Parse body object in given type. Returns null if body content is empty.</returns> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem"> <summary> Describes a work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.Id"> <summary> The work item ID. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.Rev"> <summary> Revision number of the work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.Fields"> <summary> Map of field and values for the work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.Relations"> <summary> Relations of the work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.CommentVersionRef"> <summary> Reference to a specific version of the comment added/edited/deleted in this revision. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemErrorPolicy"> <summary> Enum to control error policy in a bulk get work items request. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemErrorPolicy.Fail"> <summary> Fail work error policy. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemErrorPolicy.Omit"> <summary> Omit work error policy. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand"> <summary> Flag to control payload properties from get work item command. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand.None"> <summary> Default behavior. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand.Relations"> <summary> Relations work item expand. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand.Fields"> <summary> Fields work item expand. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand.Links"> <summary> Links work item expand. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand.All"> <summary> Expands all. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldUpdate"> <summary> Describes an update to a work item field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldUpdate.OldValue"> <summary> The old value of the field. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemFieldUpdate.NewValue"> <summary> The new value of the field. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemNextStateOnTransition"> <summary> Describes the next state for a work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemNextStateOnTransition.Id"> <summary> Work item ID. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemNextStateOnTransition.StateOnTransition"> <summary> Name of the next state on transition. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemNextStateOnTransition.Message"> <summary> Error message if there is no next state transition possible. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemNextStateOnTransition.ErrorCode"> <summary> Error code if there is no next state transition possible. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemReference"> <summary> Contains reference to a work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemReference.Id"> <summary> Work item ID. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemReference.Url"> <summary> REST API URL of the resource </summary> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemReference.#ctor(System.String)"> <summary> internal use only - for ISecuredObject information </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemRevisionReference"> <summary> Contains reference to a work item and its revision. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemRevisionReference.Rev"> <summary> Revision number of the work item. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTemplate"> <summary> Describes a work item template. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTemplate.Fields"> <summary> Mapping of field and its templated value. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTemplateReference"> <summary> Describes a shallow reference to a work item template. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTemplateReference.Id"> <summary> The identifier of the work item template. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTemplateReference.Name"> <summary> The name of the work item template. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTemplateReference.Description"> <summary> The description of the work item template. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTemplateReference.WorkItemTypeName"> <summary> The name of the work item type. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemUpdate"> <summary> Describes an update to a work item. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemUpdate.Id"> <summary> ID of update. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemUpdate.WorkItemId"> <summary> The work item ID. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemUpdate.Rev"> <summary> The revision number of work item update. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemUpdate.RevisedBy"> <summary> Identity for the work item update. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemUpdate.RevisedDate"> <summary> The work item updates revision date. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemUpdate.Fields"> <summary> List of updates to fields. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemUpdate.Relations"> <summary> List of updates to relations. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTrackingResource"> <summary> Base class for WIT REST resources. </summary> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTrackingResource.Links"> <summary> Link references to related REST resources. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTrackingResourceReference"> <summary> Base class for work item tracking resource references. </summary> </member> <!-- Badly formed XML comment ignored for member "P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTrackingResourceReference.Url" --> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.DualIntentSecuredObject"> <summary> Dual intent object with ISecuredObject implementation at collection/project level respectively </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.ArtifactQueryDualIntentSecuredObject"> <summary> WorkItemService.GetWorkItemIdsForArtifactUris ensures `CrossProjectAccess` permission validated for member/org users for collection API </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.WorkItemTrackingWebConstants"> <summary> General constants specific to the WorkItemTracking Web Layer </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.WorkItemTrackingWebConstants.RestAreaId"> <summary> The first fragment of reporting rest URIs </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.WorkItemTrackingRestResources"> <summary> Used for Area variables, Controller names and Route names </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.WorkItemTrackingLocationIds"> <summary> Web API Route location IDs for versioned routes </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.QueryParameters"> <summary> Query parameter names used in Http Request messages </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.SecurityConstants.CommonStructureNodeSecurityNamespaceGuid"> <summary> Security namespace for area nodes. </summary> </member> <member name="F:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.SecurityConstants.IterationNodeSecurityNamespaceGuid"> <summary> Security namespace guid for iteration nodes. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.SecurityConstants.AuthorizationCssNodePermissions"> <summary> Permission bits for Area nodes. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.SecurityConstants.AuthorizationIterationNodePermissions"> <summary> Permission bits for iteration nodes. </summary> </member> <member name="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.SecurityConstants.QueryItemPermissions"> <summary> Permissions bits for query items. </summary> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.SecurityConstants.GetRootClassificationNodeToken(System.Guid)"> <summary> Gets security token for root level classification nodes (area node and iteration node). Note: This will return invalid token for any node other than root-node (it will not throw exception or return null). Example to get root level area node: witClient.GetClassificationNodeAsync(projectId, TreeStructureGroup.Areas, depth: 0).SyncResult().Identifier; Example to get root level Iteration node: witClient.GetClassificationNodeAsync(projectId, TreeStructureGroup.Iterations, depth: 0).SyncResult().Identifier; </summary> <param name="nodeId">Guid of root level node</param> <returns>Security token for the given root node.</returns> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WitConstants.SecurityConstants.GetSharedQueriesFolderToken(System.Guid,System.Guid)"> <summary> Gets security token for shared query folder. Note: This will return invalid token for any query guid other than shared query folder guid (it will not throw exception or return null). Example to get SharedQueryFolderGuid: witClient.GetQueriesAsync(projectId, depth: 1).SyncResult().First(s => s.IsPublic.Value); </summary> <param name="projectId">Project guid.</param> <param name="sharedQueriesFolderId">guid of shared query folder of the project.</param> <returns>security token for shared query folder.</returns> </member> <member name="P:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient.LastResponseStatusCode"> <summary> <see cref="T:System.Net.HttpStatusCode"/> of the last response </summary> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient.GetQueriesBatchAsync(System.Collections.Generic.IEnumerable{System.Guid},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Retrieves a single query by project and either id or path </summary> <param name="ids">Query ids</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient.ExecuteBatchRequest(System.Collections.Generic.IEnumerable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Executes a batch request </summary> <param name="requests">The batch requests to execute</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> <returns>The list of responses for each request.</returns> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient.CreateWorkItemBatchRequest(System.Int32,Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Boolean,System.Boolean)"> <summary> Creates the batch request for editing a work item </summary> <param name="id">The if of the work item to edit</param> <param name="document">The patch document containing the edit operations</param> <param name="bypassRules">When true the rule engine will not run. Requires project collection administrator permissions.</param> <param name="suppressNotifications">When true, notifications will not be generated for this request. Requires project collection administrator permissions.</param> <returns>The batch request representing the edit of a work item.</returns> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient.CreateWorkItemBatchRequest(System.Guid,System.String,Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Boolean,System.Boolean)"> <summary> Creates the batch request for creating a work item </summary> <param name="projectId">The project id where the work item will be created in.</param> <param name="type">The type of the work item to create.</param> <param name="document">The patch document containing the edit operations</param> <param name="bypassRules">When true the rule engine will not run. Requires project collection administrator permissions.</param> <param name="suppressNotifications">When true, notifications will not be generated for this request. Requires project collection administrator permissions.</param> <returns>The batch request representing the creation of a work item.</returns> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient.CreateWorkItemBatchRequest(System.String,System.String,Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Boolean,System.Boolean)"> <summary> Creates the batch request for creating a work item </summary> <param name="project">The name of the project where the work item will be created in.</param> <param name="type">The type of the work item to create.</param> <param name="document">The patch document containing the edit operations</param> <param name="bypassRules">When true the rule engine will not run. Requires project collection administrator permissions.</param> <param name="suppressNotifications">When true, notifications will not be generated for this request. Requires project collection administrator permissions.</param> <returns>The batch request representing the creation of a work item.</returns> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetDependentFieldsAsync(System.String,System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns the dependent fields for the corresponding workitem type and fieldname. </summary> <param name="project">Project ID or project name</param> <param name="type">The work item type name</param> <param name="field"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetDependentFieldsAsync(System.Guid,System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns the dependent fields for the corresponding workitem type and fieldname. </summary> <param name="project">Project ID</param> <param name="type">The work item type name</param> <param name="field"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetWorkItemTypeFieldAsync(System.String,System.String,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get field of a work item type. </summary> <param name="project">Project ID or project name</param> <param name="type">Work item type</param> <param name="field"></param> <param name="expand">Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetAttachmentContentAsync(System.Guid,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Downloads an attachment. </summary> <param name="id">Attachment ID</param> <param name="fileName">Name of the file</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetAttachmentZipAsync(System.Guid,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Downloads an attachment. </summary> <param name="id">Attachment ID</param> <param name="fileName">Name of the file</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetWorkItemTypeFieldAsync(System.Guid,System.String,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get field of a work item type. </summary> <param name="project">Project ID</param> <param name="type">Work item type</param> <param name="field"></param> <param name="expand">Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetWorkItemTypeFieldsAsync(System.String,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a list of fields for a work Item type. </summary> <param name="project">Project ID or project name</param> <param name="type">Work item type.</param> <param name="expand">Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetWorkItemTypeFieldsAsync(System.Guid,System.String,System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a list of fields for a work Item type. </summary> <param name="project">Project ID</param> <param name="type">Work item type.</param> <param name="expand">Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.CreateAttachmentAsync(System.IO.Stream,System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Creates an attachment. </summary> <param name="uploadStream">Stream to upload</param> <param name="fileName"></param> <param name="uploadType"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetHistoryAsync(System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns history of all revision for a given work item ID </summary> <param name="id"></param> <param name="top"></param> <param name="skip"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetHistoryByIdAsync(System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Returns the history value of particular revision </summary> <param name="id"></param> <param name="revisionNumber"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions </summary> <param name="project">Project ID or project name</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="watermark">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.Guid,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions </summary> <param name="project">Project ID</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="watermark">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.String,System.Boolean,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions with the option of including deleted items </summary> <param name="project">Project ID or project name</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="watermark">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.Guid,System.Boolean,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions with the option of including deleted items </summary> <param name="project">Project ID</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="watermark">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions </summary> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="watermark">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.Boolean,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions with the option of including deleted items </summary> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="watermark">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions with the option of including deleted items </summary> <param name="project">Project ID or project name</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="includeTagRef">Specify if the tag objects should be returned for System.Tags field.</param> <param name="includeLatestOnly">Return only the latest revisions of work items, skipping all historical revisions</param> <param name="expand">Return all the fields in work item revisions, including long text fields which are not returned by default</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.Guid,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions with the option of including deleted items </summary> <param name="project">Project ID</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="includeTagRef">Specify if the tag objects should be returned for System.Tags field.</param> <param name="includeLatestOnly">Return only the latest revisions of work items, skipping all historical revisions</param> <param name="expand">Return all the fields in work item revisions, including long text fields which are not returned by default</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions with the option of including deleted items </summary> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="includeTagRef">Specify if the tag objects should be returned for System.Tags field.</param> <param name="includeLatestOnly">Return only the latest revisions of work items, skipping all historical revisions</param> <param name="expand">Return all the fields in work item revisions, including long text fields which are not returned by default</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions with the option of including deleted items </summary> <param name="project">Project ID or project name</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="includeTagRef">Specify if the tag objects should be returned for System.Tags field.</param> <param name="includeLatestOnly">Return only the latest revisions of work items, skipping all historical revisions</param> <param name="expand">Return all the fields in work item revisions, including long text fields which are not returned by default</param> <param name="includeDiscussionChangesOnly">Return only the those revisions of work items, where only history field was changed</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.Guid,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions with the option of including deleted items </summary> <param name="project">Project ID</param> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="includeTagRef">Specify if the tag objects should be returned for System.Tags field.</param> <param name="includeLatestOnly">Return only the latest revisions of work items, skipping all historical revisions</param> <param name="expand">Return all the fields in work item revisions, including long text fields which are not returned by default</param> <param name="includeDiscussionChangesOnly">Return only the those revisions of work items, where only history field was changed</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsGetAsync(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions with the option of including deleted items </summary> <param name="fields">A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.</param> <param name="types">A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.</param> <param name="continuationToken">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="includeIdentityRef">Return an identity reference instead of a string value for identity fields.</param> <param name="includeDeleted">Specify if the deleted item should be returned.</param> <param name="includeTagRef">Specify if the tag objects should be returned for System.Tags field.</param> <param name="includeLatestOnly">Return only the latest revisions of work items, skipping all historical revisions</param> <param name="expand">Return all the fields in work item revisions, including long text fields which are not returned by default</param> <param name="includeDiscussionChangesOnly">Return only the those revisions of work items, where only history field was changed</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsPostAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter,System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions </summary> <param name="filter">An object that contains request settings: field filter, type filter, identity format</param> <param name="watermark">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsPostAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter,System.String,System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions </summary> <param name="filter">An object that contains request settings: field filter, type filter, identity format</param> <param name="project">Project ID or project name</param> <param name="watermark">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.ReadReportingRevisionsPostAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsFilter,System.Guid,System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Get a batch of work item revisions </summary> <param name="filter">An object that contains request settings: field filter, type filter, identity format</param> <param name="project">Project ID</param> <param name="watermark">Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.</param> <param name="startDateTime">Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetDeletedWorkItemsAsync(System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetDeletedWorkItemsAsync(System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetDeletedWorkItemsAsync(System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetDeletedWorkItemReferencesAsync(System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin. </summary> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetDeletedWorkItemReferencesAsync(System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin. </summary> <param name="project">Project ID or project name</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetDeletedWorkItemReferencesAsync(System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin. </summary> <param name="project">Project ID</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.CreateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="document"></param> <param name="project">Project ID or project name</param> <param name="type"></param> <param name="validateOnly"></param> <param name="bypassRules"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.CreateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Guid,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="document"></param> <param name="project">Project ID</param> <param name="type"></param> <param name="validateOnly"></param> <param name="bypassRules"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.CreateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Creates a single work item. </summary> <param name="document">The JSON Patch document representing the work item</param> <param name="project">Project ID or project name</param> <param name="type">The work item type of the work item to create</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.CreateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Guid,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Creates a single work item. </summary> <param name="document">The JSON Patch document representing the work item</param> <param name="project">Project ID</param> <param name="type">The work item type of the work item to create</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.UpdateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Int32,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="document"></param> <param name="id"></param> <param name="validateOnly"></param> <param name="bypassRules"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.UpdateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Int32,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Updates a single work item. </summary> <param name="document">The JSON Patch document representing the update</param> <param name="id">The id of the work item to update</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.UpdateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.String,System.Int32,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Updates a single work item. </summary> <param name="document">The JSON Patch document representing the update</param> <param name="project">Project ID or project name</param> <param name="id">The id of the work item to update</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.UpdateWorkItemAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument,System.Guid,System.Int32,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Updates a single work item. </summary> <param name="document">The JSON Patch document representing the update</param> <param name="project">Project ID</param> <param name="id">The id of the work item to update</param> <param name="validateOnly">Indicate if you only want to validate the changes without saving the work item</param> <param name="bypassRules">Do not enforce the work item type rules on this update</param> <param name="suppressNotifications">Do not fire any notifications for this change</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetWorkItemsForArtifactUrisAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ArtifactUriQuery,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Queries work items linked to a given list of artifact URI. </summary> <param name="artifactUriQuery">Defines a list of artifact URI for querying work items.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.UpdateRemoteLinksAsync(System.Collections.Generic.IEnumerable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.RemoteWorkItemLinkUpdate},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="links"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.CleanupRemoteLinksFromProjectDelete(System.Collections.Generic.IEnumerable{System.Guid},System.Guid,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] </summary> <param name="links"></param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetQueryResultCountAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.Guid,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the results of the query given the query ID. </summary> <param name="teamContext">The team context for the operation</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetQueryResultCountAsync(System.String,System.Guid,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the results of the query given the query ID. </summary> <param name="project">Project ID or project name</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetQueryResultCountAsync(System.Guid,System.Guid,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the results of the query given the query ID. </summary> <param name="project">Project ID</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetQueryResultCountAsync(System.Guid,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the results of the query given the query ID. </summary> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.QueryByIdAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext,System.Guid,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the results of the query given the query ID. </summary> <param name="teamContext">The team context for the operation</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.QueryByIdAsync(System.String,System.Guid,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the results of the query given the query ID. </summary> <param name="project">Project ID or project name</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.QueryByIdAsync(System.Guid,System.Guid,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the results of the query given the query ID. </summary> <param name="project">Project ID</param> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.QueryByIdAsync(System.Guid,System.Nullable{System.Boolean},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the results of the query given the query ID. </summary> <param name="id">The query ID.</param> <param name="timePrecision">Whether or not to use time precision.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetCommentAsync(System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets a comment for a work item at the specified revision. </summary> <param name="id">Work item id</param> <param name="revision">Revision for which the comment need to be fetched</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetCommentAsync(System.String,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets a comment for a work item at the specified revision. </summary> <param name="project">Project ID or project name</param> <param name="id">Work item id</param> <param name="revision">Revision for which the comment need to be fetched</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetCommentAsync(System.Guid,System.Int32,System.Int32,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets a comment for a work item at the specified revision. </summary> <param name="project">Project ID</param> <param name="id">Work item id</param> <param name="revision">Revision for which the comment need to be fetched</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetCommentsAsync(System.String,System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the specified number of comments for a work item from the specified revision. </summary> <param name="project">Project ID or project name</param> <param name="id">Work item id</param> <param name="fromRevision">Revision from which comments are to be fetched (default is 1)</param> <param name="top">The number of comments to return (default is 200)</param> <param name="order">Ascending or descending by revision id (default is ascending)</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetCommentsAsync(System.Guid,System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the specified number of comments for a work item from the specified revision. </summary> <param name="project">Project ID</param> <param name="id">Work item id</param> <param name="fromRevision">Revision from which comments are to be fetched (default is 1)</param> <param name="top">The number of comments to return (default is 200)</param> <param name="order">Ascending or descending by revision id (default is ascending)</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.GetCommentsAsync(System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder},System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Gets the specified number of comments for a work item from the specified revision. </summary> <param name="id">Work item id</param> <param name="fromRevision">Revision from which comments are to be fetched (default is 1)</param> <param name="top">The number of comments to return (default is 200)</param> <param name="order">Ascending or descending by revision id (default is ascending)</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.CreateQueryAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem,System.String,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Creates a query, or moves a query. </summary> <param name="postedQuery">The query to create.</param> <param name="project">Project ID or project name</param> <param name="query">The parent id or path under which the query is to be created.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> <member name="M:Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClientCompatBase.CreateQueryAsync(Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem,System.Guid,System.String,System.Object,System.Threading.CancellationToken)"> <summary> [Preview API] Creates a query, or moves a query. </summary> <param name="postedQuery">The query to create.</param> <param name="project">Project ID</param> <param name="query">The parent id or path under which the query is to be created.</param> <param name="userState"></param> <param name="cancellationToken">The cancellation token to cancel operation.</param> </member> </members> </doc> |