REST API - closeWorkItem

The table summarizes the REST API - closeWorkItem.

Request

Format 
PUT <baseurl>/workitem/close
Query parameters
  • id=long (1..n): Unique ID of the work item.
  • version=long (1..n): Version of the work item. If not set, the latest version will be used.

Response

JSON Returns a JSON representation of the content of the closeWorkItemResponse element.
XML Returns the content of the closeWorkItemResponse element (from the WorkItemManagementService schema)

Example

Request 
PUT <baseurl>/workitem/close?id=8&version=1
Response 
{
    "workItemID": {
        "@id": "8",
        "@version": "2"
    }
}