WorkItemTrackingHttpClient.CreateWorkItemBatchRequest 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
| CreateWorkItemBatchRequest(Int32, JsonPatchDocument, Boolean, Boolean) |
Creates the batch request for editing a work item |
| CreateWorkItemBatchRequest(Guid, String, JsonPatchDocument, Boolean, Boolean) |
Creates the batch request for creating a work item |
| CreateWorkItemBatchRequest(String, String, JsonPatchDocument, Boolean, Boolean) |
Creates the batch request for creating a work item |
CreateWorkItemBatchRequest(Int32, JsonPatchDocument, Boolean, Boolean)
Creates the batch request for editing a work item
public virtual Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest CreateWorkItemBatchRequest (int id, Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument document, bool bypassRules, bool suppressNotifications);abstract member CreateWorkItemBatchRequest : int * Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * bool * bool -> Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest
override this.CreateWorkItemBatchRequest : int * Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * bool * bool -> Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequestPublic Overridable Function CreateWorkItemBatchRequest (id As Integer, document As JsonPatchDocument, bypassRules As Boolean, suppressNotifications As Boolean) As WitBatchRequestParameters
- id
- Int32
The if of the work item to edit
- document
- Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument
The patch document containing the edit operations
- bypassRules
- Boolean
When true the rule engine will not run. Requires project collection administrator permissions.
- suppressNotifications
- Boolean
When true, notifications will not be generated for this request. Requires project collection administrator permissions.
Returns
The batch request representing the edit of a work item.
Applies to
CreateWorkItemBatchRequest(Guid, String, JsonPatchDocument, Boolean, Boolean)
Creates the batch request for creating a work item
public virtual Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest CreateWorkItemBatchRequest (Guid projectId, string type, Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument document, bool bypassRules, bool suppressNotifications);abstract member CreateWorkItemBatchRequest : Guid * string * Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * bool * bool -> Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest
override this.CreateWorkItemBatchRequest : Guid * string * Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * bool * bool -> Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequestPublic Overridable Function CreateWorkItemBatchRequest (projectId As Guid, type As String, document As JsonPatchDocument, bypassRules As Boolean, suppressNotifications As Boolean) As WitBatchRequestParameters
- projectId
- Guid
The project id where the work item will be created in.
- type
- String
The type of the work item to create.
- document
- Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument
The patch document containing the edit operations
- bypassRules
- Boolean
When true the rule engine will not run. Requires project collection administrator permissions.
- suppressNotifications
- Boolean
When true, notifications will not be generated for this request. Requires project collection administrator permissions.
Returns
The batch request representing the creation of a work item.
Applies to
CreateWorkItemBatchRequest(String, String, JsonPatchDocument, Boolean, Boolean)
Creates the batch request for creating a work item
public virtual Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest CreateWorkItemBatchRequest (string project, string type, Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument document, bool bypassRules, bool suppressNotifications);abstract member CreateWorkItemBatchRequest : string * string * Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * bool * bool -> Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequest
override this.CreateWorkItemBatchRequest : string * string * Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * bool * bool -> Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WitBatchRequestPublic Overridable Function CreateWorkItemBatchRequest (project As String, type As String, document As JsonPatchDocument, bypassRules As Boolean, suppressNotifications As Boolean) As WitBatchRequestParameters
- project
- String
The name of the project where the work item will be created in.
- type
- String
The type of the work item to create.
- document
- Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument
The patch document containing the edit operations
- bypassRules
- Boolean
When true the rule engine will not run. Requires project collection administrator permissions.
- suppressNotifications
- Boolean
When true, notifications will not be generated for this request. Requires project collection administrator permissions.
Returns
The batch request representing the creation of a work item.
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