Get Work Item Updates

GetWorkItemUpdates retrieves the revision history of a work item.

It calls GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{id}/updates, where {id} is the value of the Id field.

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	Specify the version of the API 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.
$ Top	Optional	Enter the maximum number of items to return from the query.
$ Skip	Optional	Enter the number of items to skip in the query results.

$ Top and $ Skip are query parameters, and together they page through the history.

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 list of updates.

note

The output schema for this activity declares the response body without describing its properties, so the fields inside body are not listed here. Individual updates carry the shape shown on Get Work Item Update.