Get Work Item Update

GetWorkItemUpdate retrieves one revision of a work item — what changed on that update and who made it.

It calls GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{id}/updates/{updateNumber}, where {id} and {updateNumber} come from the Id and Update Number fields.

The activity has four tabs: Configuration, Auth, Input, and Output.

Configuration

Field	Required	Description
Name	Optional	Name of the step, should be unique within this workflow.
Description	Optional	Describe the purpose or function of this step.
Api Version	Required	Enter the version of the API you want to use.
Organization	Optional	Enter the name of the organization.
Project	Optional	Enter the name of the project.
Id	Optional	Enter the ID of the resource.
Update Number	Optional	Enter the update number for the resource.

Auth

Field	Required	Description
Auth Type	Optional	Select the authentication method for the request. Options: No Auth, Basic, API Key, OAuth 2.
User Name	Optional	Username for Basic Authentication.
Password	Optional	Password for Basic Authentication.

Input

This activity is built on the REST Client, so the Input tab is the generic HTTP request rather than an Azure Boards-shaped payload.

Field	Required	Data Type	Description
Target	Required	Object	The HTTP request.

Output

The activity returns an httpResponse object.

Field	Data Type	Description
status.code	Integer	Numeric HTTP status code.
status.message	String	Short message associated with the HTTP status.
headers	Object	HTTP response headers.
body	Object	Parsed body of the response — the work item update.

The response body carries the update:

Field	Data Type	Description
id	Integer	ID of update.
workItemId	Integer	The work item ID.
rev	Integer	The revision number of work item update.
fields	Object	List of updates to fields.
relations	Object	Describes updates to a work item's relations.
revisedBy	Object	Describes a reference to an identity.
revisedDate	String	The work item updates revision date.