WorkItemTrackingHttpClientBase.UpdateWorkItemAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| UpdateWorkItemAsync(JsonPatchDocument, Guid, Int32, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Updates a single work item. |
| UpdateWorkItemAsync(JsonPatchDocument, Int32, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Updates a single work item. |
| UpdateWorkItemAsync(JsonPatchDocument, String, Int32, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Updates a single work item. |
UpdateWorkItemAsync(JsonPatchDocument, Guid, Int32, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Updates a single work item.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem> UpdateWorkItemAsync (Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument document, Guid project, int id, Nullable<bool> validateOnly = null, Nullable<bool> bypassRules = null, Nullable<bool> suppressNotifications = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.UpdateWorkItemAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * Guid * int * Nullable<bool> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem>Parameters
- document
- Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument
The JSON Patch document representing the update
- project
- Guid
Project ID
- id
- Int32
The id of the work item to update
Indicate if you only want to validate the changes without saving the work item
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
UpdateWorkItemAsync(JsonPatchDocument, Int32, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Updates a single work item.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem> UpdateWorkItemAsync (Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument document, int id, Nullable<bool> validateOnly = null, Nullable<bool> bypassRules = null, Nullable<bool> suppressNotifications = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.UpdateWorkItemAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * int * Nullable<bool> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem>Parameters
- document
- Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument
The JSON Patch document representing the update
- id
- Int32
The id of the work item to update
Indicate if you only want to validate the changes without saving the work item
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
UpdateWorkItemAsync(JsonPatchDocument, String, Int32, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Updates a single work item.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem> UpdateWorkItemAsync (Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument document, string project, int id, Nullable<bool> validateOnly = null, Nullable<bool> bypassRules = null, Nullable<bool> suppressNotifications = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.UpdateWorkItemAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * string * int * Nullable<bool> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem>Parameters
- document
- Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument
The JSON Patch document representing the update
- project
- String
Project ID or project name
- id
- Int32
The id of the work item to update
Indicate if you only want to validate the changes without saving the work item
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for