Skip to main content

Update Work Item

Update an existing work item in a specified project.

External Documentation

To learn more, visit the Azure DevOps documentation.

Parameters​

ParameterDescription
FieldsA JSON array of field objects to add to the created work item:"value" - the value to fill in the field."path" - the path of the field to be filled. Set to "/fields/System.Field Name" in case of a pre-existing field or to"/fields/Custom.Field Name in case of a custom field. Examples of common fields: System.Title, System.Description,System.State, System.Reason, System.Tags, System.AreaPath, System.IterationPath."from" - set to null."op" - set to "add".
IDThe id of the work item to update. You can get the Work Item ID using the List Work Items IDs action.
OrganizationThe Azure DevOps Organization. You can view the Organizations list in the Azure DevOps Organizations page.
ProjectThe Project ID or Project name. You can view the Projects list in the Azure DevOps Projects page.

Example Output​

{
    "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://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.CreatedDate": "2014-12-29T20:49:21.617Z",
        "System.CreatedBy": {
            "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": "2014-12-29T20:49:27.98Z",
        "System.ChangedBy": {
            "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.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://dev.azure.com/fabrikam/_apis/wit/workItems/297",
            "attributes": {
                "isLocked": false,
                "comment": "decomposition of work"
            }
        },
        {
            "rel": "System.LinkTypes.Related",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300",
            "attributes": {
                "isLocked": false,
                "comment": "adding another task"
            }
        },
        {
            "rel": "Hyperlink",
            "url": "http://blogs.msdn.com/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://dev.azure.com/fabrikam/_apis/wit/workItems/299"
        },
        "workItemUpdates": {
            "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299/updates"
        },
        "workItemRevisions": {
            "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299/revisions"
        },
        "workItemHistory": {
            "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299/history"
        },
        "html": {
            "href": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=299"
        },
        "workItemType": {
            "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
        },
        "fields": {
            "href": "https://dev.azure.com/fabrikam/_apis/wit/fields"
        }
    },
    "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
}

Workflow Library Example​

Update Work Item with Azure Devops and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop