EndPoint Update Work Item

Name

update_workitem

Description

Updates an existing work item in the default project within the organization. [API reference]

Parameters

Parameter

Label

Required

Options

Description

Project

Project Name

YES

The Name of the project.

Work Item Id

Operation

Option	Value
replace	replace
add	add
remove	remove
copy	copy
move	move
test	test

Some operation requires you to supply 'add' rather than 'replace' (e.g. adding new tag)

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_I4`	`int`		`False`
Title	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
Description	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
WorkItemType	`DT_WSTR`	`nvarchar(100)`	100	`False`
State	`DT_WSTR`	`nvarchar(100)`	100	`False`
Url	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
Tags	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
Revision	`DT_I4`	`int`		`False`
AreaPath	`DT_WSTR`	`nvarchar(500)`	500	`False`
TeamProject	`DT_WSTR`	`nvarchar(500)`	500	`False`
IterationPath	`DT_WSTR`	`nvarchar(500)`	500	`False`
Reason	`DT_WSTR`	`nvarchar(500)`	500	`False`
CreatedDate	`DT_DBTIMESTAMP`	`datetime`		`False`
ChangedDate	`DT_DBTIMESTAMP`	`datetime`		`False`
CommentCount	`DT_I4`	`int`		`False`
AssignedToDisplayName	`DT_WSTR`	`nvarchar(500)`	500	`False`
AssignedToUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
AssignedToLinksAvatarHref	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
AssignedToId	`DT_WSTR`	`nvarchar(500)`	500	`False`
AssignedToUniqueName	`DT_WSTR`	`nvarchar(500)`	500	`False`
AssignedToImageUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
AssignedToDescriptor	`DT_WSTR`	`nvarchar(2000)`	2000	`False`
CreatedByDisplayName	`DT_WSTR`	`nvarchar(500)`	500	`False`
CreatedByUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
CreatedByLinksAvatarHref	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
CreatedById	`DT_WSTR`	`nvarchar(500)`	500	`False`
CreatedByUniqueName	`DT_WSTR`	`nvarchar(500)`	500	`False`
CreatedByImageUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
CreatedByDescriptor	`DT_WSTR`	`nvarchar(2000)`	2000	`False`
ChangedByDisplayName	`DT_WSTR`	`nvarchar(500)`	500	`False`
ChangedByUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ChangedByLinksAvatarHref	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ChangedById	`DT_WSTR`	`nvarchar(500)`	500	`False`
ChangedByUniqueName	`DT_WSTR`	`nvarchar(500)`	500	`False`
ChangedByImageUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ChangedByDescriptor	`DT_WSTR`	`nvarchar(2000)`	2000	`False`
Watermark	`DT_WSTR`	`nvarchar(500)`	500	`False`
StateChangeDate	`DT_DBTIMESTAMP`	`datetime`		`False`
Priority	`DT_I4`	`int`		`False`
Triage	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
StackRank	`DT_I4`	`int`		`False`
Blocked	`DT_WSTR`	`nvarchar(500)`	500	`False`
TaskType	`DT_WSTR`	`nvarchar(500)`	500	`False`
RequiresReview	`DT_WSTR`	`nvarchar(100)`	100	`False`
RequiresTest	`DT_WSTR`	`nvarchar(100)`	100	`False`
ActivatedDate	`DT_DBTIMESTAMP`	`datetime`		`False`
ActivatedByDisplayName	`DT_WSTR`	`nvarchar(500)`	500	`False`
ActivatedByUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ActivatedByLinksAvatarHref	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ActivatedById	`DT_WSTR`	`nvarchar(500)`	500	`False`
ActivatedByUniqueName	`DT_WSTR`	`nvarchar(500)`	500	`False`
ActivatedByImageUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ActivatedByDescriptor	`DT_WSTR`	`nvarchar(2000)`	2000	`False`
ClosedDate	`DT_DBTIMESTAMP`	`datetime`		`False`
ClosedByDisplayName	`DT_WSTR`	`nvarchar(500)`	500	`False`
ClosedByUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ClosedByLinksAvatarHref	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ClosedById	`DT_WSTR`	`nvarchar(500)`	500	`False`
ClosedByUniqueName	`DT_WSTR`	`nvarchar(500)`	500	`False`
ClosedByImageUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ClosedByDescriptor	`DT_WSTR`	`nvarchar(2000)`	2000	`False`
ResolvedDate	`DT_DBTIMESTAMP`	`datetime`		`False`
ResolvedByDisplayName	`DT_WSTR`	`nvarchar(500)`	500	`False`
ResolvedByUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ResolvedByLinksAvatarHref	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ResolvedById	`DT_WSTR`	`nvarchar(500)`	500	`False`
ResolvedByUniqueName	`DT_WSTR`	`nvarchar(500)`	500	`False`
ResolvedByImageUrl	`DT_WSTR`	`nvarchar(2048)`	2048	`False`
ResolvedByDescriptor	`DT_WSTR`	`nvarchar(2000)`	2000	`False`
ResolvedReason	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
AreaId	`DT_WSTR`	`nvarchar(500)`	500	`False`
IterationId	`DT_WSTR`	`nvarchar(500)`	500	`False`
RevisedDate	`DT_DBTIMESTAMP`	`datetime`		`False`
RemoteLinkCount	`DT_I4`	`int`		`False`
RelatedLinkCount	`DT_I4`	`int`		`False`
HyperLinkCount	`DT_I4`	`int`		`False`
ExternalLinkCount	`DT_I4`	`int`		`False`
History	`DT_WSTR`	`nvarchar(2000)`	2000	`False`
IntegrationBuild	`DT_WSTR`	`nvarchar(500)`	500	`False`
FoundIn	`DT_WSTR`	`nvarchar(500)`	500	`False`
OriginalEstimate	`DT_R4`	`real`		`False`
RemainingWork	`DT_R4`	`real`		`False`
CompletedWork	`DT_R4`	`real`		`False`
Size	`DT_R4`	`real`		`False`
Effort	`DT_R4`	`real`		`False`
TargetDate	`DT_DBTIMESTAMP`	`datetime`		`False`
StoryPoints	`DT_R4`	`real`		`False`
StartDate	`DT_DBTIMESTAMP`	`datetime`		`False`
FinishDate	`DT_DBTIMESTAMP`	`datetime`		`False`
DueDate	`DT_DBTIMESTAMP`	`datetime`		`False`
Discipline	`DT_WSTR`	`nvarchar(500)`	500	`False`
SystemInfo	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
Steps	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
ReproSteps	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
[$parent.referenceName$]	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
WorkItemType	`DT_WSTR`	`nvarchar(1000)`	1000	`True`
Title	`DT_WSTR`	`nvarchar(1000)`	1000	`True`
Description	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
State	`DT_WSTR`	`nvarchar(100)`	100	`True`
History	`DT_WSTR`	`nvarchar(100)`	100	`True`
Tags	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
Revision	`DT_I4`	`int`		`True`
AreaPath	`DT_WSTR`	`nvarchar(500)`	500	`True`
TeamProject	`DT_WSTR`	`nvarchar(500)`	500	`True`
IterationPath	`DT_WSTR`	`nvarchar(500)`	500	`True`
Reason	`DT_WSTR`	`nvarchar(500)`	500	`True`
AssignedTo	`DT_WSTR`	`nvarchar(500)`	500	`True`
Priority	`DT_I4`	`int`		`True`
Triage	`DT_WSTR`	`nvarchar(1000)`	1000	`True`
StackRank	`DT_I4`	`int`		`True`
Blocked	`DT_WSTR`	`nvarchar(500)`	500	`True`
TaskType	`DT_WSTR`	`nvarchar(500)`	500	`True`
RequiresReview	`DT_WSTR`	`nvarchar(100)`	100	`True`
RequiresTest	`DT_WSTR`	`nvarchar(100)`	100	`True`
ActivatedDate	`DT_DBTIMESTAMP`	`datetime`		`True`
ActivatedBy	`DT_WSTR`	`nvarchar(500)`	500	`True`
ClosedDate	`DT_DBTIMESTAMP`	`datetime`		`True`
ClosedBy	`DT_WSTR`	`nvarchar(500)`	500	`True`
ResolvedDate	`DT_DBTIMESTAMP`	`datetime`		`True`
ResolvedReason	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
IntegrationBuild	`DT_WSTR`	`nvarchar(500)`	500	`True`
FoundIn	`DT_WSTR`	`nvarchar(500)`	500	`True`
OriginalEstimate	`DT_R4`	`real`		`True`
RemainingWork	`DT_R4`	`real`		`True`
CompletedWork	`DT_R4`	`real`		`True`
Size	`DT_R4`	`real`		`True`
Effort	`DT_R4`	`real`		`True`
TargetDate	`DT_DBTIMESTAMP`	`datetime`		`True`
StartDate	`DT_DBTIMESTAMP`	`datetime`		`True`
FinishDate	`DT_DBTIMESTAMP`	`datetime`		`True`
DueDate	`DT_DBTIMESTAMP`	`datetime`		`True`
StoryPoints	`DT_R4`	`real`		`True`
Discipline	`DT_WSTR`	`nvarchar(100)`	100	`True`
SystemInfo	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
Steps	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
ReproSteps	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
[$parent.referenceName$]	`DT_WSTR`	`nvarchar(4000)`	4000	`True`

Required columns that you need to supply are bolded.

Examples

SSIS

Use Azure DevOps Connector in API Source component to read data or in API Destination component to read/write data:

Update rows in WorkItems table using API Destination

This EndPoint belongs to WorkItems table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Azure DevOps

WorkItems

Update