Updates - Get

Service:: Work Item Tracking

API Version:: 7.1

Returns a single update for a work item

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{id}/updates/{updateNumber}?api-version=7.1

URI Parameters

Name	In	Required	Type	Description
id	path	True	integer (int32)
organization	path	True	string	The name of the Azure DevOps organization.
updateNumber	path	True	integer (int32)
project	path		string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	WorkItemUpdate	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.work	Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.

Examples

work item update

work item update (project scoped)

work item update

Sample request

HTTP

GET https://dev.azure.com/fabrikam/_apis/wit/workItems/{id}/updates/{updateNumber}?api-version=7.1

Sample response

Status code:: 200

{
  "id": 1,
  "workItemId": 1,
  "rev": 1,
  "revisedBy": {
    "displayName": "Jamal Hartnett",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      }
    },
    "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
    "uniqueName": "fabrikamfiber4@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
    "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
  },
  "revisedDate": "2017-09-04T02:28:56.253Z",
  "fields": {
    "System.Id": {
      "newValue": 1
    },
    "System.AreaId": {
      "newValue": 2
    },
    "System.NodeName": {
      "newValue": "MyAgilePro1"
    },
    "System.AreaLevel1": {
      "newValue": "MyAgilePro1"
    },
    "System.Rev": {
      "newValue": 1
    },
    "System.AuthorizedDate": {
      "newValue": "2017-09-04T02:08:16.6Z"
    },
    "System.RevisedDate": {
      "newValue": "2017-09-04T02:28:56.253Z"
    },
    "System.IterationId": {
      "newValue": 3
    },
    "System.IterationLevel1": {
      "newValue": "MyAgilePro1"
    },
    "System.IterationLevel2": {
      "newValue": "Iteration 1"
    },
    "System.WorkItemType": {
      "newValue": "Bug"
    },
    "System.State": {
      "newValue": "New"
    },
    "System.Reason": {
      "newValue": "New"
    },
    "System.AssignedTo": {},
    "System.CreatedDate": {
      "newValue": "2017-09-04T02:08:16.6Z"
    },
    "System.CreatedBy": {
      "newValue": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      }
    },
    "System.ChangedDate": {
      "newValue": "2017-09-04T02:08:16.6Z"
    },
    "System.ChangedBy": {
      "newValue": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      }
    },
    "System.AuthorizedAs": {
      "newValue": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      }
    },
    "System.PersonId": {
      "newValue": 90562141
    },
    "System.Watermark": {
      "newValue": 1
    },
    "System.IsDeleted": {
      "newValue": false
    },
    "System.TeamProject": {
      "newValue": "MyAgilePro1"
    },
    "System.AreaPath": {
      "newValue": "MyAgilePro1"
    },
    "System.IterationPath": {
      "newValue": "MyAgilePro1\\Iteration 1"
    },
    "System.Title": {
      "newValue": "Bug 1"
    },
    "Microsoft.VSTS.Common.Priority": {
      "newValue": 2
    },
    "Microsoft.VSTS.Common.Severity": {
      "newValue": "3 - Medium"
    },
    "Microsoft.VSTS.Common.ValueArea": {
      "newValue": "Business"
    },
    "Microsoft.VSTS.Common.StateChangeDate": {
      "newValue": "2017-09-04T02:08:16.6Z"
    },
    "System.Tags": {
      "newValue": ""
    }
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItems/1/updates/1"
    },
    "workItemUpdates": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1/updates"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItems/1/updates/1"
}

work item update (project scoped)

Sample request

HTTP

GET https://dev.azure.com/fabrikam/_apis/wit/workItems/{id}/updates/{updateNumber}?api-version=7.1

Sample response

Status code:: 200

{
  "id": 1,
  "workItemId": 1,
  "rev": 1,
  "revisedBy": {
    "displayName": "Jamal Hartnett",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      }
    },
    "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
    "uniqueName": "fabrikamfiber4@hotmail.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
    "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
  },
  "revisedDate": "2017-09-04T02:28:56.253Z",
  "fields": {
    "System.Id": {
      "newValue": 1
    },
    "System.AreaId": {
      "newValue": 2
    },
    "System.NodeName": {
      "newValue": "MyAgilePro1"
    },
    "System.AreaLevel1": {
      "newValue": "MyAgilePro1"
    },
    "System.Rev": {
      "newValue": 1
    },
    "System.AuthorizedDate": {
      "newValue": "2017-09-04T02:08:16.6Z"
    },
    "System.RevisedDate": {
      "newValue": "2017-09-04T02:28:56.253Z"
    },
    "System.IterationId": {
      "newValue": 3
    },
    "System.IterationLevel1": {
      "newValue": "MyAgilePro1"
    },
    "System.IterationLevel2": {
      "newValue": "Iteration 1"
    },
    "System.WorkItemType": {
      "newValue": "Bug"
    },
    "System.State": {
      "newValue": "New"
    },
    "System.Reason": {
      "newValue": "New"
    },
    "System.AssignedTo": {},
    "System.CreatedDate": {
      "newValue": "2017-09-04T02:08:16.6Z"
    },
    "System.CreatedBy": {
      "newValue": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      }
    },
    "System.ChangedDate": {
      "newValue": "2017-09-04T02:08:16.6Z"
    },
    "System.ChangedBy": {
      "newValue": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      }
    },
    "System.AuthorizedAs": {
      "newValue": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      }
    },
    "System.PersonId": {
      "newValue": 90562141
    },
    "System.Watermark": {
      "newValue": 1
    },
    "System.IsDeleted": {
      "newValue": false
    },
    "System.TeamProject": {
      "newValue": "MyAgilePro1"
    },
    "System.AreaPath": {
      "newValue": "MyAgilePro1"
    },
    "System.IterationPath": {
      "newValue": "MyAgilePro1\\Iteration 1"
    },
    "System.Title": {
      "newValue": "Bug 1"
    },
    "Microsoft.VSTS.Common.Priority": {
      "newValue": 2
    },
    "Microsoft.VSTS.Common.Severity": {
      "newValue": "3 - Medium"
    },
    "Microsoft.VSTS.Common.ValueArea": {
      "newValue": "Business"
    },
    "Microsoft.VSTS.Common.StateChangeDate": {
      "newValue": "2017-09-04T02:08:16.6Z"
    },
    "System.Tags": {
      "newValue": ""
    }
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItems/1/updates/1"
    },
    "workItemUpdates": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1/updates"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItems/1/updates/1"
}

Definitions

Name	Description
IdentityReference	Describes a reference to an identity.
ReferenceLinks	The class to represent a collection of REST reference links.
WorkItemFieldUpdate	Describes an update to a work item field.
WorkItemRelation
WorkItemRelationUpdates	Describes updates to a work item's relations.
WorkItemUpdate	Describes an update to a work item.

IdentityReference

Object

Describes a reference to an identity.

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string (uuid)
imageUrl	string	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
name	string	Legacy back-compat property. This has been the WIT specific value from Constants. Will be hidden (but exists) on the client unless they are targeting the newest version
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

ReferenceLinks

Object

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

WorkItemFieldUpdate

Object

Describes an update to a work item field.

Name	Type	Description
newValue	object	The new value of the field.
oldValue	object	The old value of the field.

WorkItemRelation

Object

Name	Type	Description
attributes	object	Collection of link attributes.
rel	string	Relation type.
url	string	Link url.

WorkItemRelationUpdates

Object

Describes updates to a work item's relations.

Name	Type	Description
added	WorkItemRelation[]	List of newly added relations.
removed	WorkItemRelation[]	List of removed relations.
updated	WorkItemRelation[]	List of updated relations.

WorkItemUpdate

Object

Describes an update to a work item.

Name	Type	Description
_links	ReferenceLinks	Link references to related REST resources.
fields	<string, WorkItemFieldUpdate>	List of updates to fields.
id	integer (int32)	ID of update.
relations	WorkItemRelationUpdates	List of updates to relations.
rev	integer (int32)	The revision number of work item update.
revisedBy	IdentityReference	Identity for the work item update.
revisedDate	string (date-time)	The work item updates revision date.
url	string
workItemId	integer (int32)	The work item ID.

Share via

Updates - Get

URI Parameters

Responses

Security

oauth2

Scopes

Examples

work item update

Sample request

Sample response

work item update (project scoped)

Sample request

Sample response

Definitions

IdentityReference

ReferenceLinks

WorkItemFieldUpdate

WorkItemRelation

WorkItemRelationUpdates

WorkItemUpdate