WorkItemDelete

Ref

  

Less than 1 minute to read

  

2024-09-06 09:35:04 +0100

draft

This page is in draft and may include errors or omissions. Please check the discussions for any pending updates and changes to the content or to suggest your own changes.

The WorkItemDelete processor allows you to delete any amount of work items that meet the query. DANGER: This is not a recoverable action and should be use with extream caution.

Options

Parameter name	Type	Description	Default Value
Enabled	Boolean	missng XML code comments	missng XML code comments
FilterWorkItemsThatAlreadyExistInTarget	Boolean	missng XML code comments	missng XML code comments
PauseAfterEachWorkItem	Boolean	missng XML code comments	missng XML code comments
WIQLQuery	String	missng XML code comments	missng XML code comments
WorkItemCreateRetryLimit	Int32	missng XML code comments	missng XML code comments
WorkItemIDs	IList	missng XML code comments	missng XML code comments

Example

A basic sample for WorkItemDelete configuration.

{
  "$type": "WorkItemDeleteConfig",
  "Enabled": false,
  "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc",
  "WorkItemIDs": null,
  "FilterWorkItemsThatAlreadyExistInTarget": false,
  "PauseAfterEachWorkItem": false,
  "WorkItemCreateRetryLimit": 0
}