REST API - getWorkItemHeader

The table summarizes the REST API - getWorkItemHeader.

Request

Format 
GET <baseurl>/workitem/getheader
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 getWorkItemHeaderResponse element.
XML Returns the content of the getWorkItemHeaderResponse element (from the WorkItemManagementService schema)

Example

Request 
GET <baseurl>/workitem/getheader?id=1&version=0
Response 
{
    "workItemHeader": {
        "@distributionStrategy": "OFFER",
        "@priority": "50",
        "@startDate": "2013-01-22T14:06:27.297Z",
        "name": "GetUsersName",
        "description": "Get User's Name",
        "flags": {
            "scheduleStatus": "DURING"
        },
        "itemContext": {
            "activityID": "pvm:001i8",
            "activityName": "GetUsersName",
            "appInstance": "pvm:0a122",
            "appName": "WelcomeUsersChained",
            "appID": "_h3SuNATvEd-PnpTAZS_CFw"
        }
    }
}